Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs-source/spring/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ Oracle Database and other infrastructure components that operate on multiple clo
building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.

 
{{< hint type=[warning] icon=gdoc_fire title="Version 1.1.2 (production) released March, 2024" >}}
Oracle Backend for Spring Boot and Microservices Version 1.1.2 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.
{{< hint type=[warning] icon=gdoc_fire title="Version 1.1.3 (production) released March, 2024" >}}
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.
{{< /hint >}}
&nbsp;

Expand Down
4 changes: 2 additions & 2 deletions docs-source/spring/content/azure/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Watch this video for a quick overview of the setup process.

## Download

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

## Setup

Expand Down Expand Up @@ -55,7 +55,7 @@ The Multicloud installation is done using the Azure Cloud Shell. The following s

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

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

![Azure Upload](AzureUpload.png)

Expand Down
6 changes: 3 additions & 3 deletions docs-source/spring/content/development/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: "cli tool deployment spring springboot microservices development oracl
---

The Oracle Backend for Spring Boot and Microservices offers a command-line interface (CLI), `oractl`. The CLI commands simplify the deployment of
microservices applications as well as bindings with the resources that they use. Download the CLI [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.2). The platform-specific binary can be renamed to `oractl` for convenience.
microservices applications as well as bindings with the resources that they use. Download the CLI [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.3). The platform-specific binary can be renamed to `oractl` for convenience.

Table of Contents:

Expand All @@ -32,7 +32,7 @@ The Oracle Backend for Spring Boot CLI is used to configure your backend and to

1. Download the Oracle Backend for Spring Boot and Microservices CLI `oractl`

Download the CLI from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.2)
Download the CLI from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.3)

1. Rename the downloaded file to `oractl`

Expand Down Expand Up @@ -70,7 +70,7 @@ The Oracle Backend for Spring Boot CLI is used to configure your backend and to
\_/ |_) (_| (_| __) \_ |_ _|_
========================================================================================
Application Name: Oracle Backend Platform :: Command Line Interface
Application Version: (1.1.2)
Application Version: (1.1.3)
:: Spring Boot (v3.2.1) ::

Ask for help:
Expand Down
2 changes: 1 addition & 1 deletion docs-source/spring/content/get-help/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Two utilities will help Oracle diagnose and fix issues you may experience.

### Baseline

The [baseline script](https://github.com/oracle/microservices-datadriven/blob/main/support/baseline) will collect non-sensitive information about your cluster and can be used to compare the current cluster state with a baseline state. This will help to quickly identify any discrepancies between a stable deployment and the current deployments.
The [baseline command (Linux only)](https://raw.githubusercontent.com/oracle/microservices-datadriven/main/support/baseline) will collect non-sensitive information about your cluster and can be used to compare the current cluster state with a baseline state. This will help to quickly identify any discrepancies between a stable deployment and the current deployments.

The baseline utility can be run in one of three modes:

Expand Down
18 changes: 18 additions & 0 deletions docs-source/spring/content/observability/metrics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ resources:
- name: apache-apisix-dashboard
src: "apache-apisix-dashboard.png"
title: "Apache APISIX Observability Dashboard"
- name: vault-dashboard
src: "vault-grafana.png"
title: "Apache APISIX Observability Dashboard"
---

Oracle Backend for Spring Boot and Microservices provides built-in platform services to collect metrics from system and application workloads and pre-built Grafana dashboards to view and explore those metrics.
Expand All @@ -58,6 +61,7 @@ On this page, you will find the following topics:
- [Oracle Database Dashboard](#oracle-database-dashboard)
- [Kube State Metrics Dashboard](#kube-state-metrics-dashboard)
- [Apache APISIX DashBoard](#apache-apisix-dashboard)
- [HashiCorp Vault Dashboard](#hashicorp-vault-dashboard)
- [How to have metrics collected for your applications](#how-to-have-metrics-collected-for-your-applications)
- [How to access Prometheus](#how-to-access-prometheus)
- [How to access Grafana](#how-to-access-grafana)
Expand Down Expand Up @@ -171,6 +175,20 @@ Here is an example of this dashboard:
{{< img name="apache-apisix-dashboard" size="medium" lazy=false >}}
<!-- spellchecker-enable -->

### HashiCorp Vault Dashboard

This dashboard provides details of the HashiCorp Vault including:

- Health and seal status
- Number of secrets
- Number of operations

Here is an example of this dashboard:

<!-- spellchecker-disable -->
{{< img name="vault-dashboard" size="medium" lazy=false >}}
<!-- spellchecker-enable -->

## How to have metrics collected for your applications

When you deploy an application with Oracle Backend for Spring Boot and Microservices CLI or Visual Code Extension, provided you included the Eureka Discovery Client and Actuator in your application, Prometheus will automatically find your application (using the service registry) and start collecting metrics. These metrics will be included in both the Spring Boot Observability dashboard and the Spring Boot Statistic dashboard automatically.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs-source/spring/content/on-premises/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ When installing in a _non-production_ environment, for example a developer's des

## Download

Download the latest release of [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.2/onprem-ebaas_latest.zip).
Download the latest release of [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.3/onprem-ebaas_latest.zip).

## Setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ If Minikube fails to start and returns this `Failed kubeconfig update: could not

### Download Oracle Backend for Spring Boot and Microservices

Download the latest version of [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.2/onprem-ebaas_latest.zip) and unzip into a new directory.
Download the latest version of [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.3/onprem-ebaas_latest.zip) and unzip into a new directory.

### Install Ansible

Expand Down
2 changes: 1 addition & 1 deletion docs-source/spring/content/on-premises/ol8/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ useradd obaas

### Download Oracle Backend for Spring Boot and Microservices

Download the latest version of [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.2/onprem-ebaas_latest.zip) and unzip into a new directory.
Download the latest version of [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.3/onprem-ebaas_latest.zip) and unzip into a new directory.

As the `obaas` user, run this command:

Expand Down
4 changes: 2 additions & 2 deletions docs-source/spring/content/platform/apigw/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "API Gateway"
description: "APISIX Gateway for API management in Oracle Backend for Spring Boot and Microservices"
title: "Apache APISIX Gateway"
description: "Apache APISIX Gateway for API management in Oracle Backend for Spring Boot and Microservices"
keywords: "api apisix gateway traffic deployment circuitbreaker spring springboot microservices oracle backend"
resources:
- name: obaas-apisix-k8s
Expand Down
12 changes: 5 additions & 7 deletions docs-source/spring/content/platform/eureka/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Service Discovery"
title: "Eureka Service Discovery"
description: "Service discovery with Spring Eureka Service Registry in Oracle Backend for Spring Boot and Microservices"
keywords: "service discovery registry eureka springboot spring development microservices oracle backend"
resources:
Expand All @@ -10,22 +10,20 @@ resources:

Oracle Backend for Spring Boot and Microservices includes the Spring Boot Eureka service registry, which is an application that stores information about client services or applications. Typically, each Microservice registers with the Eureka server at startup and the Eureka server maintains a list of all active instances of the service, including their ports and IP addresses. This information can be accessed by other services using a well-known key. This allows services to interact with each other without needing to know the other addresses at development or deployment time.

### Access the Eureka Web User Interface
## Access the Eureka Web User Interface

To access the Eureka web user interface, process these steps:

1. Expose the Eureka web user interface using this command:

```shell
kubectl port-forward -n eureka svc/eureka 8761:8761
kubectl port-forward -n eureka svc/eureka 8761
```

2. Open the Eureka web user interface URL <http://localhost:8761>
1. Open the Eureka web user interface URL <http://localhost:8761>

<!-- spellchecker-disable -->
{{< img name="obaas-eureka-dashboard" size="medium" lazy=false >}}
<!-- spellchecker-enable -->

* On the web page, you see all of the services registered with Eureka. If you deployed the [sample applications](../../sample-apps), look for an entry called **SLOW**. The presence of this entry confirms that the application successfully registered itself with the service registry.

* You should also see the **CONFIG-SERVER** and **ADMIN-SERVER** applications. These applications are deployed as part of the platform.
On the dashboard you will see all the internal services registered with Eureka. If you have deployed the sample application [CloudBank](https://github.com/oracle/microservices-datadriven/tree/main/cloudbank-v32) or done the [LiveLab for Oracle Backend for Spring Boot and Microservices](http://bit.ly/CloudBankOnOBaaS) you will see those services.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 14 additions & 11 deletions docs-source/spring/content/platform/soc/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ resources:
---


Oracle Backend for Spring Boot and Microservices version 1.1.2 includes a preview of a new feature called "Spring Operations Center".
Oracle Backend for Spring Boot and Microservices version 1.1.3 includes a preview of a new feature called "Spring Operations Center".
More capabilities will be added to this feature in future releases.

The Spring Operations Center provides a web user interface to manage the Oracle Backend for Spring Boot and Microservices.
Expand All @@ -38,6 +38,14 @@ This preview release includes the following capabilities:

**Note:** More capabilities will be added to this feature in future releases.

- [Accessing Spring Operations Center](#accessing-spring-operations-center)
- [The Dashboard](#the-dashboard)
- [Manage Namespaces](#manage-namespaces)
- [Manage Workloads](#manage-workloads)
- [Manage Identity](#manage-identity)

## Accessing Spring Operations Center

To access the Spring Operations Center, obtain the public IP address for your environment using this command:

```bash
Expand All @@ -50,23 +58,21 @@ Use the `EXTERNAL-IP` from the results and open a browser to https://100.200.100

**Note**: If you installed with self-signed certificates, which is the default, you will see a browser warning message and
will have to click on "Accept risk" or similar. For information about replacing the self-signed certificate with a
production certicate, refer to [Transport Layer Security](../../security#transport-layer-security)
production certificate, refer to [Transport Layer Security](../../security#transport-layer-security)

<!-- spellchecker-disable -->
{{< img name="soc-login-page" size="medium" lazy=false >}}
<!-- spellchecker-enable -->

Login using the `obaas-admin` user (or another user if you have created one) and the password
that you set during installation. If you did not set a password, one was auto-generated for you and can be
obtain with this command:
Login using the `obaas-admin` user (or another user if you have created one) and the password that you set during installation. If you did not set a password, one was auto-generated for you and can be obtained with this command:

```bash
$ kubectl get secret -n azn-server oractl-passwords -o jsonpath='{.data.admin}' | base64 -d
```

After logging in, you will see the SOC Dashboard.

### The Dashboard
## The Dashboard

The Spring Operations Center Dashboard provides information about the overall state of the environment including:

Expand All @@ -83,10 +89,7 @@ The Spring Operations Center Dashboard provides information about the overall st

### Manage Namespaces

The Manage Namespaces screen is accessible from the *Workloads* menu, and allows you to view and manage the namespaces
that are configured for Spring Boot application deployments. Note that this does not show you all namespaces in the
Kubernetes cluster, just those that have be specifically configured for Spring Boot workloads, meaning they have
the necessary secrets for pulling images, accessing the database, and so on.
The Manage Namespaces screen is accessible from the *Workloads* menu, and allows you to view and manage the namespaces that are configured for Spring Boot application deployments. Note that this does not show you all namespaces in the Kubernetes cluster, just those that have be specifically configured for Spring Boot workloads, meaning they have the necessary secrets for pulling images, accessing the database, and so on.

<!-- spellchecker-disable -->
{{< img name="soc-manage-namespaces" size="medium" lazy=false >}}
Expand All @@ -98,7 +101,7 @@ deployed there.
### Manage Workloads

The Manage Workloads screen shows the workloads (Spring Boot applications) deployed in a specific namespace, including
the status of each workload, and how many replicas are currently running and desired.
the status of each workload, and how many replicas are currently running and desired.

<!-- spellchecker-disable -->
{{< img name="soc-manage-workloads" size="medium" lazy=false >}}
Expand Down
15 changes: 4 additions & 11 deletions docs-source/spring/content/platform/spring-admin/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,18 @@ the applications:
1. Expose the Spring Boot Admin dashboard using this command:

```shell
kubectl -n admin-server port-forward svc/admin-server 8989:8989
kubectl -n admin-server port-forward svc/admin-server 8989
```

2. Open the Spring Boot Admin dashboard URL: <http://localhost:8989>

* username: `admin`
* password: `admin`

**NOTE:** Oracle recommends that you change the default password when you log in for the first time. Even though the dashboard is not accessible externally, Oracle still recommends using strong passwords to maximize security.
1. Open the Spring Boot Admin dashboard URL: <http://localhost:8989>

<!-- spellchecker-disable -->
{{< img name="obaas-springadmin-apps" size="medium" lazy=false >}}
<!-- spellchecker-enable -->

3. On the web page, navigate to the **Applications** tab:
On the dashboard you will see all the internal services registered with Eureka. If you have deployed the sample application [CloudBank](https://github.com/oracle/microservices-datadriven/tree/main/cloudbank-v32) or done the [LiveLab for Oracle Backend for Spring Boot and Microservices](http://bit.ly/CloudBankOnOBaaS) you will see those services.

* If you deployed the [Sample Applications](../../sample-apps), find and click the **SLOW** entry to expand it.
* Click on the instance of the service.
* Notice that you can see details about the service instance, metrics, configuration, and so on.
If you click (expand) an application and click on the instance of service you will details about the service instance, metrics, configuration, and so on,

<!-- spellchecker-disable -->
{{< img name="obaas-springadmin-svc-details" size="medium" lazy=false >}}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading