Skip to content

Commit b8bfb65

Browse files
authored
1.1.3 Docu updates (#858)
Documentation update 1.1.3
1 parent 58150b6 commit b8bfb65

Some content is hidden

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

45 files changed

+196
-124
lines changed

docs-source/spring/content/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,8 @@ Oracle Database and other infrastructure components that operate on multiple clo
99
building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.
1010

1111
 
12-
{{< hint type=[warning] icon=gdoc_fire title="Version 1.1.2 (production) released March, 2024" >}}
13-
Oracle Backend for Spring Boot and Microservices Version 1.1.2 is now generally available and suitable
14-
for production use. This version supports and recommends Spring Boot 3.2.x, Spring 6.1 and Spring Cloud 2023.0.0,
15-
with limited backwards compatibility for Spring Boot 2.7.x.
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.
1614
{{< /hint >}}
1715
&nbsp;
1816

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Watch this video for a quick overview of the setup process.
2222

2323
## Download
2424

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

2727
## Setup
2828

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

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

58-
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:
58+
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:
5959

6060
![Azure Upload](AzureUpload.png)
6161

docs-source/spring/content/development/cli/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ keywords: "cli tool deployment spring springboot microservices development oracl
55
---
66

77
The Oracle Backend for Spring Boot and Microservices offers a command-line interface (CLI), `oractl`. The CLI commands simplify the deployment of
8-
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.
8+
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.
99

1010
Table of Contents:
1111

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

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

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

3737
1. Rename the downloaded file to `oractl`
3838

@@ -70,7 +70,7 @@ The Oracle Backend for Spring Boot CLI is used to configure your backend and to
7070
\_/ |_) (_| (_| __) \_ |_ _|_
7171
========================================================================================
7272
Application Name: Oracle Backend Platform :: Command Line Interface
73-
Application Version: (1.1.2)
73+
Application Version: (1.1.3)
7474
:: Spring Boot (v3.2.1) ::
7575
7676
Ask for help:

docs-source/spring/content/get-help/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Two utilities will help Oracle diagnose and fix issues you may experience.
2121

2222
### Baseline
2323

24-
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.
24+
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.
2525

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

docs-source/spring/content/observability/metrics/_index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ resources:
4545
- name: apache-apisix-dashboard
4646
src: "apache-apisix-dashboard.png"
4747
title: "Apache APISIX Observability Dashboard"
48+
- name: vault-dashboard
49+
src: "vault-grafana.png"
50+
title: "Apache APISIX Observability Dashboard"
4851
---
4952

5053
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.
@@ -58,6 +61,7 @@ On this page, you will find the following topics:
5861
- [Oracle Database Dashboard](#oracle-database-dashboard)
5962
- [Kube State Metrics Dashboard](#kube-state-metrics-dashboard)
6063
- [Apache APISIX DashBoard](#apache-apisix-dashboard)
64+
- [HashiCorp Vault Dashboard](#hashicorp-vault-dashboard)
6165
- [How to have metrics collected for your applications](#how-to-have-metrics-collected-for-your-applications)
6266
- [How to access Prometheus](#how-to-access-prometheus)
6367
- [How to access Grafana](#how-to-access-grafana)
@@ -171,6 +175,20 @@ Here is an example of this dashboard:
171175
{{< img name="apache-apisix-dashboard" size="medium" lazy=false >}}
172176
<!-- spellchecker-enable -->
173177

178+
### HashiCorp Vault Dashboard
179+
180+
This dashboard provides details of the HashiCorp Vault including:
181+
182+
- Health and seal status
183+
- Number of secrets
184+
- Number of operations
185+
186+
Here is an example of this dashboard:
187+
188+
<!-- spellchecker-disable -->
189+
{{< img name="vault-dashboard" size="medium" lazy=false >}}
190+
<!-- spellchecker-enable -->
191+
174192
## How to have metrics collected for your applications
175193

176194
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.
Loading

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ When installing in a _non-production_ environment, for example a developer's des
2727

2828
## Download
2929

30-
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).
30+
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).
3131

3232
## Setup
3333

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If Minikube fails to start and returns this `Failed kubeconfig update: could not
5656

5757
### Download Oracle Backend for Spring Boot and Microservices
5858

59-
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.
59+
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.
6060

6161
### Install Ansible
6262

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ useradd obaas
2222

2323
### Download Oracle Backend for Spring Boot and Microservices
2424

25-
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.
25+
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.
2626

2727
As the `obaas` user, run this command:
2828

docs-source/spring/content/platform/apigw/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "API Gateway"
3-
description: "APISIX Gateway for API management in Oracle Backend for Spring Boot and Microservices"
2+
title: "Apache APISIX Gateway"
3+
description: "Apache APISIX Gateway for API management in Oracle Backend for Spring Boot and Microservices"
44
keywords: "api apisix gateway traffic deployment circuitbreaker spring springboot microservices oracle backend"
55
resources:
66
- name: obaas-apisix-k8s
Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Service Discovery"
2+
title: "Eureka Service Discovery"
33
description: "Service discovery with Spring Eureka Service Registry in Oracle Backend for Spring Boot and Microservices"
44
keywords: "service discovery registry eureka springboot spring development microservices oracle backend"
55
resources:
@@ -10,22 +10,20 @@ resources:
1010

1111
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.
1212

13-
### Access the Eureka Web User Interface
13+
## Access the Eureka Web User Interface
1414

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

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

1919
```shell
20-
kubectl port-forward -n eureka svc/eureka 8761:8761
20+
kubectl port-forward -n eureka svc/eureka 8761
2121
```
2222

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

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

29-
* 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.
30-
31-
* You should also see the **CONFIG-SERVER** and **ADMIN-SERVER** applications. These applications are deployed as part of the platform.
29+
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

docs-source/spring/content/platform/soc/_index.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ resources:
2424
---
2525

2626

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

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

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

41+
- [Accessing Spring Operations Center](#accessing-spring-operations-center)
42+
- [The Dashboard](#the-dashboard)
43+
- [Manage Namespaces](#manage-namespaces)
44+
- [Manage Workloads](#manage-workloads)
45+
- [Manage Identity](#manage-identity)
46+
47+
## Accessing Spring Operations Center
48+
4149
To access the Spring Operations Center, obtain the public IP address for your environment using this command:
4250

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

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

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

59-
Login using the `obaas-admin` user (or another user if you have created one) and the password
60-
that you set during installation. If you did not set a password, one was auto-generated for you and can be
61-
obtain with this command:
67+
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:
6268

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

6773
After logging in, you will see the SOC Dashboard.
6874

69-
### The Dashboard
75+
## The Dashboard
7076

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

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

8490
### Manage Namespaces
8591

86-
The Manage Namespaces screen is accessible from the *Workloads* menu, and allows you to view and manage the namespaces
87-
that are configured for Spring Boot application deployments. Note that this does not show you all namespaces in the
88-
Kubernetes cluster, just those that have be specifically configured for Spring Boot workloads, meaning they have
89-
the necessary secrets for pulling images, accessing the database, and so on.
92+
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.
9093

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

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

103106
<!-- spellchecker-disable -->
104107
{{< img name="soc-manage-workloads" size="medium" lazy=false >}}

docs-source/spring/content/platform/spring-admin/_index.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,18 @@ the applications:
2323
1. Expose the Spring Boot Admin dashboard using this command:
2424

2525
```shell
26-
kubectl -n admin-server port-forward svc/admin-server 8989:8989
26+
kubectl -n admin-server port-forward svc/admin-server 8989
2727
```
2828

29-
2. Open the Spring Boot Admin dashboard URL: <http://localhost:8989>
30-
31-
* username: `admin`
32-
* password: `admin`
33-
34-
**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.
29+
1. Open the Spring Boot Admin dashboard URL: <http://localhost:8989>
3530

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

40-
3. On the web page, navigate to the **Applications** tab:
35+
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.
4136

42-
* If you deployed the [Sample Applications](../../sample-apps), find and click the **SLOW** entry to expand it.
43-
* Click on the instance of the service.
44-
* Notice that you can see details about the service instance, metrics, configuration, and so on.
37+
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,
4538

4639
<!-- spellchecker-disable -->
4740
{{< img name="obaas-springadmin-svc-details" size="medium" lazy=false >}}
Loading
Loading

0 commit comments

Comments
 (0)