Skip to content

Commit 1eaa50f

Browse files
authored
2.0.0-M3 docs (#1093)
2.0.0 Initial documentation
1 parent 3f91bf0 commit 1eaa50f

22 files changed

+779
-12
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Deploy",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Deploy applications to OBaaS."
7+
}
8+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Build and Deploy the application
3+
sidebar_position: 2
4+
---
5+
## Build and Deploy the application
6+
7+
:::important
8+
This content is TBD
9+
:::
10+
11+
These are the steps to deploy the application to ak8s cluster using Helm.
12+
13+
- Obtain the deployment Helm chart from [here](hhtp://where)
14+
- Edit `Values.yaml` to refelct your application
15+
- Install the Helm chart.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Deploy the Application
3+
sidebar_position: 4
4+
---
5+
## Deploy the application
6+
7+
:::important
8+
This content is TBD
9+
:::
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Introduction and Installation Flow
3+
sidebar_position: 1
4+
---
5+
## Introduction and Installation flow
6+
7+
:::important
8+
This content is TBD
9+
:::
10+
11+
This guide explains how to deploy an application to OBaaS using Eclipse [Eclipse JKube](https://eclipse.dev/jkube/) to build and push a container image, and Helm to install and configure the application on a Kubernetes cluster.
12+
13+
### Prerequisites
14+
15+
- Access to a container image repository (e.g., OCIR or another approved registry).
16+
- Kubernetes cluster access with the correct context set.
17+
- Helm installed locally.
18+
- Maven build configured for your project.
19+
20+
### High Level Installation Flow
21+
22+
Too deploy an application to OBaaS, you will follow this high-level flow:
23+
24+
- Obtain Image Repository metadata or Create the repository needed for the deployment.
25+
- Add [Eclipse JKube](https://eclipse.dev/jkube/) to the pom.xml file.
26+
- Build the Application using Maven.
27+
- Obtain the deployment Helm chart.
28+
- If you're using a database, create a secret with database credentials etc.
29+
- Create the database application user using the 'sqljob.yaml' file. **Add to Helm dir with 'if' statement**
30+
- Edit the `Chart.yaml` file to reflect the application name.
31+
- Install the Helm chart.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Run the SQL Job
3+
sidebar_position: 3
4+
---
5+
## Run the SQL Job
6+
7+
:::important
8+
This content is TBD
9+
:::
10+
11+
:::note
12+
This step is only necessary if your application is connecting to a database.
13+
:::
14+
15+
Open the `sqljob.yaml` file and edit the section .....
16+
17+
Execute `kubectl -f sqljob.yaml`. You can verify that the job executed properly by running the following commands (get the pod, look at the log) `l log -n .... <podname>`
18+
19+
```log
20+
asdasd
21+
asdasd
22+
asd
23+
```

docs-source/site/docs/intro.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,3 @@ sidebar_position: 1
55
# Oracle Backend for Microservices and AI
66

77
Oracle Backend for Microservices and AI allows developers to build microservices in Helidon and/or Spring Boot and provisions a “backend as a service” with Oracle Database and other infrastructure components that operate on multiple clouds. Oracle Backend for Microservices and AI vastly simplifies the task of building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.
8-
9-
**Content TBD**
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Platform Services",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Oracle Backend for Microservices and AI includes a number of Spring platform components that provide services to applications deployed to the platform."
7+
}
8+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Platform Services
3+
sidebar_position: 1
4+
---
5+
6+
:::important
7+
This content is TBD
8+
:::

docs-source/site/docs/setup/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 1,
44
"link": {
55
"type": "generated-index",
6-
"description": "OBaaS setup and installation."
6+
"description": "Oracle Backend for Microservices and AI (OBaaS) setup and installation."
77
}
88
}
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Prepare and Install the OBaaS Database Helm chart
3+
sidebar_position: 9
4+
---
5+
## Prepare and Install the OBaaS Database Helm chart
6+
7+
For this step, you will need the **obaas-db** directory in which you will see the following files:
8+
9+
```bash
10+
cd obaas-db/
11+
ls
12+
Chart.yaml scripts templates values.yaml
13+
```
14+
15+
You must edit the **values.yaml** file as follows:
16+
17+
- If you are using a private repository, you must update each **image** entry to point to your private repository instead of the public repositories.
18+
19+
- You must update the values in the **database.oci_config** section as follows:
20+
21+
- The **oke** setting must be **false**. Setting this to true is not supported in 2.0.0-M3.
22+
23+
- Supply your **tenancy**, **user** ocid, **fingerprint** and **region**. These must match the details you provided when you created the OCI configuration secret earlier. This information can be found in the OCI configuration file.
24+
25+
- (Optional) If you want to install any components in this chart into their own separate namespace, you can override the global namespace by setting a value in the **namespace** property inside the section for that component.
26+
27+
**Important note**: Please pause to double check all of the values are correct. If there are any errors here, the database provisioning will fail.
28+
29+
Install the Helm chart using the following command:
30+
31+
```bash
32+
helm --debug install obaas-db --set global.obaasName="obaas-dev" --set global.targetNamespace="obaas-dev" ./
33+
NAME: obaas-db
34+
LAST DEPLOYED: Sun Aug 17 13:09:20 2025
35+
NAMESPACE: default
36+
STATUS: deployed
37+
REVISION: 1
38+
TEST SUITE: None
39+
```
40+
41+
When the installation has completed, you can use `helm ls` command to view the installed charts:
42+
43+
```text
44+
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
45+
obaas-db default 1 2025-09-12 13:51:23.751199 -0500 CDT deployed OBaaS-db-0.1.0 2.0.0-M3
46+
obaas-observability default 1 2025-09-12 13:45:43.113298 -0500 CDT deployed OBaaS-observability-0.1.0 2.0.0-M3
47+
obaas-prereqs default 1 2025-09-12 13:37:16.026781 -0500 CDT deployed OBaaS-Prerequisites-0.0.1 2.0.0-M3
48+
```
49+
50+
If you overrode the namespace for this component, you will see a new namespace called **oracle-database-operator-system** (for example) and the following pods. Otherwise the pods will be in the **obaas-dev** namespace (or whatever name you chose).
51+
52+
![DB Operator pods](media/image6.png)
53+
54+
**Note**: If you are installing multiple OBaaS instances in your cluster, each one MUST have a different release name, `obaasName` and `targetNamespace`. For example:
55+
56+
```bash
57+
# for obaas-dev:
58+
helm install obaas-db --set global.obaasName="obaas-dev"
59+
--set global.targetNamespace="obaas-dev" ./
60+
61+
# for obaas-prod
62+
helm install obaas-prod-db --set global.obaasName="obaas-prod"
63+
--set global.targetNamespace="obaas-prod" ./
64+
```

0 commit comments

Comments
 (0)