Skip to content

Commit 3c5daa4

Browse files
markxnelsongotsysdbaandytaelcorradodebari
authored
Doc updates for 1.0 release (#756)
Update docs for 1.0 release --------- Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com> Co-authored-by: John Lathouwers <john.lathouwers@oracle.com> Co-authored-by: Andy Tael <andy.tael@yahoo.com> Co-authored-by: corradodebari <corrado.de.bari@oracle.com>
1 parent 1982b94 commit 3c5daa4

File tree

73 files changed

+737
-455
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+737
-455
lines changed

docs-source/mbaas/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Engine for Kubernetes (OKE) for customer usage with Oracle Backend for Parse Pla
1616

1717
&nbsp;
1818
{{< hint type=[warning] icon=gdoc_fire title="Interested in Spring Boot or Microservices, too?" >}}
19-
Check out [Oracle Backend for Spring Boot](https://oracle.github.io/microservices-datadriven/spring/)
19+
Check out [Oracle Backend for Spring Boot and Microservices](https://oracle.github.io/microservices-datadriven/spring/)
2020
{{< /hint >}}
2121
&nbsp;
2222

docs-source/mbaas/content/azure/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The Multicloud installation is done using the Azure Cloud Shell. The following
5151

5252
![Azure Cloud Shell Icon](AzureCloudShellIcon.png)
5353

54-
3. Upload the [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-mbaas_latest.zip) stack. For example:
54+
3. Upload the [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-mbaas_latest.zip) stack. For example:
5555

5656
![Azure Upload](AzureUpload.png)
5757

docs-source/mbaas/content/on-premises/_index.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The _Desktop_ installation can be used to explore a non-Production environment,
1313

1414
You must meet the following prerequisites to use the Oracle Backend for Parse Platform On-Premises. You need access to:
1515

16-
* An Oracle Database Enterprise Edition 21.3.0.0
16+
* An Oracle Database Enterprise Edition 19.3.0.0
1717
* A Container Repository
1818
* A Kubernetes cluster
1919
* [Python 3+](https://www.python.org/)
@@ -54,50 +54,51 @@ The _Desktop_ installation provisions an Oracle Database into the Kubernetes clu
5454

5555
After installing Podman:
5656

57-
1. Log in to the Container Registry:
57+
1. Log in to the Container Registry:
5858

5959
`podman login container-registry.oracle.com`
60-
61-
2. Pull the database image:
6260

63-
`podman pull container-registry.oracle.com/database/enterprise:21.3.0.0`
64-
65-
3. Pull the ORDS image:
61+
2. Pull the database image:
62+
63+
`podman pull container-registry.oracle.com/database/enterprise:19.3.0.0`
64+
65+
3. Pull the ORDS image:
6666

6767
`podman pull container-registry.oracle.com/database/ords:21.4.2-gh`
6868

6969
### Defining the Parse Application (_Estate_ Installation)
7070

71-
The Parse application is defined in `ansible/vars/baas.yaml`. For example:
71+
The application is defined in `ansible/vars/mbaas.yaml`. For example:
7272

7373
```yaml
7474
---
75+
mbaas_edition: "COMMUNITY"
7576
app_name: "MYAPP"
7677
app_id: "PiITzsu3RCc499RRDOYOBgWnyAlMm6695r1536y1"
7778
master_key: "Q5CP7MHpoZhSwbk39XpHxamp4rJJ4F3vPZ3NZ7ee"
7879
dashboard_username: "ADMIN"
7980
dashboard_password: "OZ0-mSt-27Evb-Qy"
8081
storage: ""
81-
access_key: ""
82-
private_key: ""
82+
access_key: "N/A"
83+
private_key: "N/A"
8384
...
8485
```
8586

8687
You can use any arbitrary string as your `app_name`, `app_id`, and `master_key`. These are used by your clients to authenticate with the Parse Server. It is recommended to specify a unique `dashboard_username` and `dashboard_password`.
8788

8889
### Defining the Database (_Estate_ Installation)
8990

90-
The database is defined in `ansible/roles/database/vars/main.yaml`. For example:
91+
The database is defined in `ansible/roles/database/vars/main.yaml`. For example:
9192

9293
```yaml
9394
---
94-
oracle_dbs: ['BAASPDB']
95-
default_db: BAASPDB
96-
BAASPDB:
97-
username: 'PDBADMIN'
98-
password: 'Correct-horse-Battery-staple-35'
99-
service: '(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=BAASPDB)))'
100-
ocid: ''
95+
database_oracle_dbs: ["BAASPDB"]
96+
database_default_db: BAASPDB
97+
BAASPDB: # noqa: var-naming[pattern]
98+
username: "PDBADMIN"
99+
password: "Correct-horse-Battery-staple-35"
100+
service: "(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=BAASPDB)))"
101+
ocid: ""
101102
...
102103
```
103104

@@ -110,25 +111,24 @@ The Container Repository is defined in `ansible/roles/registry/vars/main.yaml`.
110111

111112
```yaml
112113
---
113-
compartment_ocid: ''
114-
registry_username: 'oracle'
115-
registry_password: 'Correct-horse-Battery-staple-35'
116-
push_registry_url: 'docker.io/myorg'
117-
push_registry_auth:
114+
registry_username: "oracle"
115+
registry_password: "Correct-horse-Battery-staple-35"
116+
registry_push_url: "docker.io/myorg"
117+
registry_push_auth:
118118
auths:
119119
docker.io/myorg:
120-
auth: 'b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0'
121-
pull_registry_url: 'docker.io/myorg'
122-
pull_registry_auth:
120+
auth: "b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0"
121+
registry_pull_url: "docker.io/myorg"
122+
registry_pull_auth:
123123
auths:
124124
docker.io/myorg:
125-
auth: 'b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0'
125+
auth: "b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0"
126126
...
127127
```
128128

129-
Specify the URL or authentication credentials for your Container Repository in `pull_registry_url`, `push_registry_url`, `registry_username`, and `registry_password`.
129+
Specify the URL or authentication credentials for your Container Repository in `registry_pull_url`, `registry_push_url`, `registry_username`, and `registry_password`.
130130

131-
For the `push_registry_auth` and `pull_registry_auth` sections, manually log into your repository and copy the values found in created file, located in `$HOME/.config/containers/auth.json`
131+
For the `registry_pull_auth` and `registry_push_auth` sections, manually log into your repository and copy the values found in created file, located in `$HOME/.config/containers/auth.json`
132132

133133
Why is there duplication between the push and pull URL's? The push URL is used from the deployment machine while the pull URL is used inside the pods. If you
134134
have a private registry inside the Kubernetes cluster, these URL's could be different. This is the case for the _Desktop_ installation. The push URL

docs-source/mbaas/content/on-premises/macos_ventura/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ minikube start --cpus 4 --memory max --container-runtime=containerd
4949
minikube addons enable ingress
5050
```
5151

52-
### Download Oracle Backend for Spring Boot
52+
### Download Oracle Backend for Spring Boot and Microservices
5353

5454
Download the [Oracle Backend for Parse Server](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/onprem-mbaas_latest.zip) and unzip into a new directory.
5555

@@ -100,7 +100,7 @@ Build and push the images to the Container Registry in the Kubernetes cluster by
100100

101101
After the images are built and pushed, the tunnel is no longer required and can be stopped.
102102

103-
### Deploy Oracle Backend for Spring Boot
103+
### Deploy Oracle Backend for Spring Boot and Microservices
104104

105105
Deploy the database and Microservices by running this command:
106106

docs-source/mbaas/content/on-premises/ol8/_index.md

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,30 @@ Read [On-Premises](../index.md) and ensure that your desktop meets the minimum s
1212

1313
### Additional Operating System Packages
1414

15-
Install the following operating system packages:
15+
As the `root` user, install the following operating system packages:
1616

1717
```bash
18-
sudo dnf -y module install container-tools:ol8
19-
sudo dnf -y install conntrack podman curl
20-
sudo dnf -y install oracle-database-preinstall-21c
21-
sudo dnf -y install langpacks-en
22-
sudo dnf module install python39
18+
dnf -y module install container-tools:ol8
19+
dnf -y install conntrack podman curl
20+
dnf -y install oracle-database-preinstall-21c
21+
dnf -y install langpacks-en
22+
dnf module install -y python39
23+
dnf -y update
2324
```
2425

2526
Set the default Python3 to Python 3.9:
2627

2728
```bash
28-
sudo alternatives --set python3 /usr/bin/python3.9
29+
alternatives --set python3 /usr/bin/python3.9
30+
```
31+
32+
### Install MiniKube
33+
34+
As the `root` user, install minikube:
35+
36+
```bash
37+
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
38+
install minikube-linux-amd64 /usr/local/bin/minikube
2939
```
3040

3141
### Create a Non-Root User
@@ -48,23 +58,16 @@ As the `obaas` user, take these steps:
4858
1. Log in to the Container Registry:
4959

5060
`podman login container-registry.oracle.com`
51-
61+
5262
2. Pull the database image:
5363

54-
`podman pull container-registry.oracle.com/database/enterprise:19.19.0.0`
55-
64+
`podman pull container-registry.oracle.com/database/enterprise:19.3.0.0`
65+
5666
3. Pull the ORDS image:
5767

5868
`podman pull container-registry.oracle.com/database/ords:21.4.2-gh`
5969

60-
### Install and Start Minikube
61-
62-
As the `root` user, process these commands:
63-
64-
```bash
65-
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
66-
install minikube-linux-amd64 /usr/local/bin/minikube
67-
```
70+
### Start Minikube
6871

6972
As the `obaas` user, process these commands:
7073

@@ -109,18 +112,11 @@ Assuming the source was unzipped to `~/obaas`, as the `obaas` user, run this com
109112

110113
In order to push the images to the Container Registry in the Kubernetes cluster, open a new terminal and start a port-forward service.
111114

112-
As the `obaas` user, run this command:
113-
114-
`kubectl port-forward service/private -n container-registry 5000:5000 &`
115+
As the `obaas` user, run these commands:
115116

116-
To test access to the registry, run this command:
117-
118-
`curl -X GET -k https://localhost:5000/v2/_catalog`
119-
120-
This `curl` results in the following:
121-
122-
```text
123-
{"errors":[{"code":"UNAUTHORIZED","message":"authentication required","detail":[{"Type":"registry","Class":"","Name":"catalog","Action":"*"}]}]}
117+
```bash
118+
source ./activate.env
119+
kubectl port-forward service/private -n container-registry 5000:5000 &`
124120
```
125121

126122
### Build the Images

docs-source/mbaas/themes/hugo-geekdoc/i18n/en.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ posts_tagged_with: All posts tagged with '{{ . }}'
3636

3737
footer_build_with: >
3838
Built with <svg class="gdoc-icon gdoc_heart"><use xlink:href="#gdoc_heart"></use></svg> by Oracle
39-
footer_legal_notice: (C) 2022, Oracle and/or its affiliates
39+
footer_legal_notice: (C) 2022, 2023, Oracle and/or its affiliates
4040
footer_privacy_policy: Privacy Policy
4141
footer_content_license_prefix: >
4242
Content licensed under Universal Permissive License

docs-source/spring/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
baseURL = 'https://oracle.github.io/microservices-datadriven/spring/'
22
languageCode = 'en-us'
3-
title = 'Oracle Backend for Spring Boot'
3+
title = 'Oracle Backend for Spring Boot and Microservices'
44
theme = "hugo-geekdoc"
55

66
pluralizeListTitles = false

docs-source/spring/content/_index.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Oracle Backend for Spring Boot - Developer Preview"
2+
title: "Oracle Backend for Spring Boot and Microservices"
33
---
44

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

99
To learn more, watch this short introductory video:
1010

@@ -14,37 +14,59 @@ In addition to an Oracle Autonomous Database Serverless instance, the following
1414
Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
1515

1616
- Apache APISIX API Gateway and Dashboard
17+
- Apache Kafka
18+
- Coherence
19+
- Grafana
20+
- HashiCorp Vault
21+
- Jaeger
22+
- Loki
23+
- Netflix Conductor
24+
- OpenTelemetry Collector
25+
- Oracle Autonomous Database Serverless
26+
- Oracle Database Operator for Kubernetes (OraOperator or the operator)
27+
- Oracle Transaction Manager for Microservices (MicroTx)
28+
- Prometheus
29+
- Promtail
1730
- Spring Eureka service registry
1831
- Spring Boot Admin dashboard
1932
- Spring Cloud Config server
20-
- Netflix Conductor
21-
- Prometheus
22-
- Grafana
23-
- OpenTelemetry Collector
24-
- Jaeger
25-
- HashiCorp Vault
26-
- Apache Kafka
27-
- Coherence
2833

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

3136
- A command-line interface (CLI) to manage service deployment and configuration, including database schema management.
37+
- Visual Studio Code (VS Code) plugin to manage service deployment and configuration.
3238
- Spring Data (Java Persistence API (JPA) and Oracle JDBC) to access Oracle Database.
3339
- Oracle Java Database Connectivity (Oracle JDBC) drivers.
3440
- Spring Cloud Config client.
3541
- Spring Eureka service discovery client.
3642
- Spring Cloud OpenFeign.
3743
- OpenTelemetry Collector (including automatic instrumentation).
3844

45+
## Learn more, try it out with CloudBank!
46+
47+
To learn more about deploying and using Oracle Backend for Spring Boot and Microservices, we recommend our
48+
[CloudBank](https://bit.ly/CloudBankOnOBaaS) self-paced, on-demand hands-on lab.
49+
50+
![](./cloudbank-hol.png)
51+
52+
In the [CloudBank](https://bit.ly/CloudBankOnOBaaS) hands-on lab, you can learn how to:
53+
54+
- Install Oracle Backend for Spring Boot and Microservices.
55+
- Set up a development environment for Spring Boot.
56+
- Build Spring Boot microservices from scratch using Spring Web to create
57+
Representational State Transfer (REST) services.
58+
- Use service discovery and client-side load balancing.
59+
- Use Spring Actuator to allow monitoring of services.
60+
- Create services that use asynchronous messaging with Java Message Service (JMS) instead of REST.
61+
- Implement the Saga pattern to manage data consistency across microservices.
62+
- Use the APISIX API Gateway to expose services to clients.
63+
- Extend a provided Flutter client to add a new "cloud cash" feature that uses the services you have built.
64+
3965
&nbsp;
4066
{{< hint type=[warning] icon=gdoc_fire title="Interested in Mobile or web apps too?" >}}
4167
Check out [Oracle Backend for Parse Platform](https://oracle.github.io/microservices-datadriven/mbaas/)!
4268
{{< /hint >}}
4369
&nbsp;
4470

45-
## Developer Preview
4671

47-
This release is a *Developer Preview*. This means that not all functionality is complete. In this release, most of the planned services
48-
and components are provided. However, additional configuration options and components may be provided in a future release. We are releasing
49-
this as a *Developer Preview* to allow interested developers to try it and provide feedback.
5072

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: "Azure/OCI Multicloud Installation"
33
---
44

5-
The Oracle Backend for Spring Boot is available to install in Multicloud (Microsoft Azure (Azure) and Oracle Cloud Infrastructure (OCI)). This installation
6-
deploys the Oracle Backend for Spring Boot in Azure with an Oracle Autonomous Database running in OCI.
5+
The Oracle Backend for Spring Boot and Microservices is available to install in Multicloud (Microsoft Azure (Azure) and Oracle Cloud Infrastructure (OCI)). This installation
6+
deploys the Oracle Backend for Spring Boot and Microservices in Azure with an Oracle Autonomous Database running in OCI.
77

88
## Prerequisites
99

@@ -20,11 +20,11 @@ Watch this video for a quick overview of the setup process.
2020

2121
## Download
2222

23-
Download [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas_latest.zip).
23+
Download [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas_latest.zip).
2424

2525
## Setup
2626

27-
A few setup steps are required in both OCI and Azure to deploy the Oracle Backend for Spring Boot application.
27+
A few setup steps are required in both OCI and Azure to deploy the Oracle Backend for Spring Boot and Microservices application.
2828

2929
### OCI
3030

@@ -53,7 +53,7 @@ The Multicloud installation is done using the Azure Cloud Shell. The following s
5353

5454
![Azure Cloud Shell Icon](AzureCloudShellIcon.png)
5555

56-
3. Upload the [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas-platform_latest.zip) stack. For example:
56+
3. Upload the [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas-platform_latest.zip) stack. For example:
5757

5858
![Azure Upload](AzureUpload.png)
5959

@@ -96,4 +96,3 @@ terraform plan -out=multicloud.plan
9696
terraform apply "multicloud.plan"
9797
```
9898

99-
Next, go to the [On-Premises](../on-premises/) page to learn more.

0 commit comments

Comments
 (0)