You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
6
+
## Accelerate Your Journey to Cloud-Native Applications
7
+
8
+
Oracle Backend for Microservices and AI (OBaaS) is a comprehensive platform that transforms how developers build, deploy, and scale modern applications. By combining the power of Oracle Database with a complete microservices infrastructure, OBaaS eliminates the complexity of cloud-native development and empowers teams to focus on innovation rather than infrastructure.
9
+
10
+
## Build Faster, Scale Smarter
11
+
12
+
Whether you're building with Helidon, Spring Boot, or integrating AI capabilities, OBaaS provides a production-ready "backend as a service" that handles the heavy lifting. Deploy across multiple clouds with confidence, knowing that your platform is built on proven Oracle technology designed for enterprise-grade reliability, security, and performance.
13
+
14
+
## Why Choose Oracle Backend for Microservices and AI?
15
+
16
+
### Developer Experience First
17
+
18
+
Write code in your preferred framework—Helidon or Spring Boot—while OBaaS handles service discovery, configuration management, API gateways, and data persistence. Spend less time configuring infrastructure and more time building features that matter to your business.
19
+
20
+
### Enterprise-Grade Infrastructure
21
+
22
+
Built on Oracle Database and designed for mission-critical workloads, OBaaS provides:
23
+
24
+
-**Reliability**: High availability and disaster recovery built in
25
+
-**Security**: Enterprise-grade security controls and compliance
26
+
-**Scalability**: Elastic scaling to meet demand automatically
27
+
-**Performance**: Optimized for low latency and high throughput
28
+
29
+
### AI-Ready Platform
30
+
31
+
Leverage the power of Oracle Database 23ai to integrate artificial intelligence and machine learning directly into your applications. Build intelligent services that learn and adapt without the complexity of managing separate AI infrastructure.
32
+
33
+
### Multi-Cloud Flexibility
34
+
35
+
Deploy on Oracle Cloud Infrastructure, other cloud providers, or hybrid environments. OBaaS provides consistent operations and portability across clouds, giving you freedom from vendor lock-in.
36
+
37
+
### Simplified Operations
38
+
39
+
OBaaS vastly simplifies the task of building, testing, and operating microservices platforms. From development through production, automated workflows and integrated tooling streamline every phase of the application lifecycle.
title: Prepare and Install the OBaaS Database Helm chart
2
+
title: Prepare and Install the OBaaS Database Helm Chart
3
3
sidebar_position: 9
4
4
---
5
-
## Prepare and Install the OBaaS Database Helm chart
5
+
## Prepare and Install the OBaaS Database Helm Chart
6
6
7
-
For this step, you will need the **obaas-db** directory in which you will see the following files:
7
+
## Overview
8
+
9
+
This guide provides instructions for preparing and installing the OBaaS Database Helm chart in your Kubernetes cluster.
10
+
11
+
## Prerequisites
12
+
13
+
Navigate to the `obaas-db` directory containing the Helm chart files:
8
14
9
15
```bash
10
16
cd obaas-db/
11
17
ls
12
-
Chart.yaml scripts templates values.yaml
13
18
```
14
19
15
-
You must edit the **values.yaml** file as follows:
20
+
Expected output:
21
+
22
+
```text
23
+
Chart.yaml scripts templates values.yaml
24
+
```
25
+
26
+
## Configuration
27
+
28
+
### Editing values.yaml
29
+
30
+
Before installation, edit the `values.yaml` file according to your environment requirements.
31
+
32
+
#### Private Repository Configuration
16
33
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.
34
+
If you are using a private repository, update each `image` entry to point to your private repository instead of the public repositories.
18
35
19
-
-(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.
36
+
#### Namespace Configuration (Optional)
20
37
21
-
**Important note**: Please pause to double check all of the values are correct. If there are any errors here, the database provisioning will fail.
38
+
To install components into separate namespaces, override the global namespace by setting a value in the `namespace` property inside the component's section.
22
39
23
-
Install the Helm chart using the following command (The `--debug` flag is optional and enables verbose output from Helm).
40
+
:::warning Important
41
+
Double-check all values before proceeding. Incorrect values will cause the database provisioning to fail.
42
+
:::
24
43
25
-
- global.obaasName="obaas-dev" - Sets the OBaaS instance name.
26
-
- global.targetNamespace="obaas-dev" - Specifies the target namespace (*OPTIONAL*, only needed if you want to override the default namespace).
44
+
## Installation
27
45
28
-
**Note**: If you are installing multiple OBaaS instances in your cluster, each one MUST have a different release name, `obaasName` and `targetNamespace`.
46
+
### Single Instance Installation
47
+
48
+
Install the Helm chart using the following command:
When installing multiple OBaaS instances in your cluster, each instance must have unique values for:
77
+
78
+
- Release name
79
+
-`obaasName`
80
+
-`targetNamespace`
81
+
82
+
**Example for development instance:**
83
+
84
+
```bash
85
+
helm --debug install obaas-db \
86
+
--set global.obaasName="obaas-dev" \
87
+
--set global.targetNamespace="obaas-dev" \
88
+
./
50
89
```
51
90
52
-
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).
91
+
**Example for production instance:**
53
92
54
-
93
+
```bash
94
+
helm --debug install obaas-prod-db \
95
+
--set global.obaasName="obaas-prod" \
96
+
--set global.targetNamespace="obaas-prod" \
97
+
./
98
+
```
99
+
100
+
## Verification
55
101
56
-
**Note**: If you are installing multiple OBaaS instances in your cluster, each one MUST have a different release name, `obaasName` and `targetNamespace`. For example (The `--debug` flag is optional and enables verbose output from Helm):
102
+
### View Installed Charts
57
103
58
-
For obaas-dev:
104
+
After installation completes, view the installed Helm charts:
If you overrode the namespace for this component, you will see a new namespace (e.g., `oracle-database-operator-system`) with the following pods. Otherwise, the pods will be in your target namespace (e.g., `obaas-dev`).
Copy file name to clipboardExpand all lines: docs-source/site/docs/setup/namespace.md
+133-5Lines changed: 133 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,148 @@
2
2
title: Create Namespace(s) for OBaaS
3
3
sidebar_position: 6
4
4
---
5
-
## Create the namespace(s) for the OBaaS installation(s)
5
+
## Create Namespace(s) for OBaaS
6
6
7
-
EACH instance of OBaaS must be installed in its own dedicated/unique namespace.
7
+
## Overview
8
8
9
-
**Note**: You will only install the **obaas-prereqs** chart once per cluster, all other charts are installed once per OBaaS instance. The **obaas-prereqs** chart contains items that are cluster-wide and shared by all OBaaS instances in a cluster. If you are going to install multiple OBaaS instances (which is not supported in 2.0.0-M4) we recommend that you put the **obaas-prereqs** chart in its own namespace, separate from all OBaaS instances.
9
+
Each OBaaS instance requires its own dedicated namespace for isolation and organization within your Kubernetes cluster.
10
10
11
-
To create the namespace(s), use the following command(s). For example, to create two installations called `obaas-dev` and `obaas-prod`:
11
+
## Namespace Requirements
12
+
13
+
### Instance Isolation
14
+
15
+
Each OBaaS instance must be installed in its own unique namespace. This ensures:
16
+
17
+
- Resource isolation between instances
18
+
- Independent lifecycle management
19
+
- Clear separation of concerns
20
+
- Simplified troubleshooting and maintenance
21
+
22
+
### Prerequisites Chart Namespace
23
+
24
+
The `obaas-prereqs` chart has special considerations:
25
+
26
+
- Installed **once per cluster** (not per instance)
27
+
- Contains cluster-wide components shared by all OBaaS instances
28
+
- Should be installed in its own dedicated namespace, separate from OBaaS instances
29
+
30
+
:::info Multiple Instance Support
31
+
Multiple OBaaS instances are not supported in version 2.0.0-M4. This capability is planned for future releases.
32
+
:::
33
+
34
+
## Creating Namespaces
35
+
36
+
### Single Instance
37
+
38
+
For a single OBaaS installation, create one namespace:
39
+
40
+
```bash
41
+
kubectl create ns obaas-dev
42
+
```
43
+
44
+
Verify the namespace was created:
45
+
46
+
```bash
47
+
kubectl get ns obaas-dev
48
+
```
49
+
50
+
Expected output:
51
+
52
+
```text
53
+
NAME STATUS AGE
54
+
obaas-dev Active 5s
55
+
```
56
+
57
+
### Multiple Instances (Future Support)
58
+
59
+
When multiple instances are supported, create a namespace for each instance. For example, to create development and production installations:
60
+
61
+
**Development namespace:**
12
62
13
63
```bash
14
64
kubectl create ns obaas-dev
15
65
```
16
66
67
+
**Production namespace:**
68
+
17
69
```bash
18
70
kubectl create ns obaas-prod
19
71
```
20
72
21
-
Change the value to the desired name(s).
73
+
**Verify all namespaces:**
74
+
75
+
```bash
76
+
kubectl get ns | grep obaas
77
+
```
78
+
79
+
Expected output:
80
+
81
+
```text
82
+
obaas-dev Active 10s
83
+
obaas-prod Active 5s
84
+
```
85
+
86
+
## Namespace Naming Conventions
87
+
88
+
When naming your namespaces, consider the following best practices:
89
+
90
+
- Use lowercase letters, numbers, and hyphens only
91
+
- Keep names descriptive and meaningful (e.g., `obaas-dev`, `obaas-prod`, `obaas-staging`)
92
+
- Include environment indicators for clarity
93
+
- Avoid special characters or spaces
94
+
- Keep names concise but descriptive
95
+
96
+
**Examples of good namespace names:**
97
+
98
+
```bash
99
+
obaas-dev
100
+
obaas-production
101
+
obaas-test
102
+
obaas-staging
103
+
obaas-demo
104
+
```
105
+
106
+
## Verification
107
+
108
+
After creating namespaces, verify they exist and are active:
109
+
110
+
```bash
111
+
kubectl get namespaces
112
+
```
113
+
114
+
You should see your newly created OBaaS namespaces in the output with `Active` status.
115
+
116
+
## Troubleshooting
117
+
118
+
### Namespace Already Exists
119
+
120
+
If you receive an error that the namespace already exists:
121
+
122
+
```bash
123
+
kubectl get ns obaas-dev
124
+
```
125
+
126
+
If the namespace exists but you want to start fresh, delete it first:
127
+
128
+
```bash
129
+
kubectl delete ns obaas-dev
130
+
```
131
+
132
+
:::warning Data Loss
133
+
Deleting a namespace will remove all resources within it. Ensure you have backups if needed before deleting a namespace.
134
+
:::
135
+
136
+
### Namespace Stuck in Terminating State
137
+
138
+
If a namespace is stuck in "Terminating" state:
139
+
140
+
```bash
141
+
kubectl get ns obaas-dev
142
+
```
143
+
144
+
Check for resources preventing deletion:
145
+
146
+
```bash
147
+
kubectl api-resources --verbs=list --namespaced -o name | \
148
+
xargs -n 1 kubectl get --show-kind --ignore-not-found -n obaas-dev
0 commit comments