Skip to content

Commit d27ccad

Browse files
1.1.1 Docs (#821)
* OTEL update * Tracing update * APISIX password update * APISIX updates * Sample app update * updates for 400 auto-scaling Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com> * general review and updates Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com> * add soc docs Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com> * Spelling, version correction, linting --------- Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com> Co-authored-by: Mark Nelson <mark.x.nelson@oracle.com>
1 parent f50c3f7 commit d27ccad

File tree

25 files changed

+346
-148
lines changed

25 files changed

+346
-148
lines changed

docs-source/spring/content/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +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
&nbsp;
12-
{{< hint type=[warning] icon=gdoc_fire title="Version 1.1 (production) released February, 2024" >}}
13-
Oracle Backend for Spring Boot and Microservices Version 1.1 is now generally available and suitable
12+
{{< hint type=[warning] icon=gdoc_fire title="Version 1.1.1 (production) released February, 2024" >}}
13+
Oracle Backend for Spring Boot and Microservices Version 1.1.1 is now generally available and suitable
1414
for production use. This version supports and recommends Spring Boot 3.2.x, Spring 6.1 and Spring Cloud 2023.0.0,
1515
with limited backwards compatibility for Spring Boot 2.7.x.
1616
{{< /hint >}}
@@ -38,6 +38,7 @@ Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
3838
- Oracle Backend for Spring Boot Command Line Interface (CLI)
3939
- Oracle Backend for Spring Boot Visual Studio Code Plugin
4040
- Oracle Database Operator for Kubernetes (OraOperator or the operator)
41+
- Oracle Database Observability Exporter
4142
- Oracle Transaction Manager for Microservices (MicroTx)
4243
- Parse and Parse Dashboard (Optional)
4344
- Prometheus
@@ -79,7 +80,7 @@ In the [CloudBank](https://bit.ly/CloudBankOnOBaaS) hands-on lab, you can learn
7980
- Use the APISIX API Gateway to expose services to clients.
8081
- Extend a provided Flutter client to add a new "cloud cash" feature that uses the services you have built.
8182

82-
# Need help?
83+
## Need help?
8384

8485
We'd love to hear from you! You can contact us in the
8586
[#oracle-db-microservices](https://oracledevs.slack.com/archives/C03ALDSV272) channel in the

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

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,8 @@ NAME
262262
bind - Create or Update a schema/user and bind it to service deployment.
263263
264264
SYNOPSIS
265-
bind --action CommandConstants.BindActions --app-name String --service-name String --username String --binding-prefix String --help
265+
bind --action CommandConstants.BindActions --app-name String --service-name String
266+
--username String --binding-prefix String --help
266267
267268
OPTIONS
268269
--action CommandConstants.BindActions
@@ -322,7 +323,10 @@ NAME
322323
deploy - Deploy a service.
323324
324325
SYNOPSIS
325-
deploy --bind String --app-name String [--service-name String] [--image-version String] --service-profile String --port String --java-version String --add-health-probe boolean --liquibase-db String [--artifact-path String] --initial-replicas int --cpu-request String --graalvm-native boolean --apigw boolean --route String --apikey String --help
326+
deploy --bind String --app-name String [--service-name String] [--image-version String]
327+
--service-profile String --port String --java-version String --add-health-probe boolean
328+
--liquibase-db String [--artifact-path String] --initial-replicas int
329+
--graalvm-native boolean --apigw boolean --route String --apikey String --help
326330
327331
OPTIONS
328332
--bind String
@@ -369,10 +373,6 @@ OPTIONS
369373
The initial number of replicas
370374
[Optional, default = 1]
371375
372-
--cpu-request String
373-
The amount of CPU to request
374-
[Optional, default = 500m]
375-
376376
--graalvm-native boolean
377377
Artifact is a graalvm native compiled by Oracle Backend
378378
[Optional, default = false]
@@ -406,7 +406,8 @@ Ask for Help
406406
For example:
407407
408408
```bash
409-
oractl:>deploy --app-name myapp --service-name myserv --image-version 0.0.1 --port 8081 --bind jms --add-health-probe true --artifact-path obaas/myserv/target/demo-0.0.1-SNAPSHOT.jar
409+
oractl:>deploy --app-name myapp --service-name myserv --image-version 0.0.1 --port 8081
410+
--bind jms --add-health-probe true --artifact-path obaas/myserv/target/demo-0.0.1-SNAPSHOT.jar
410411
uploading: obaas/myserv/target/demo-0.0.1-SNAPSHOT.jar building and pushing image...
411412
binding resources... successful
412413
creating deployment and service... successfully deployed
@@ -415,7 +416,9 @@ Ask for Help
415416
or, for native compiled microservices, add **--java-version container-registry.oracle.com/os/oraclelinux:7-slim** to have a compact image and **--graalvm-native** to specify the file provided is an executable .exec:
416417
417418
```bash
418-
oractl:>deploy --app-name cloudn --service-name account --artifact-path obaas/myserv/target/accounts-0.0.1-SNAPSHOT.jar.exec --image-version 0.0.1 --graalvm-native --java-version container-registry.oracle.com/os/oraclelinux:7-slim
419+
oractl:>deploy --app-name myapp --service-name account
420+
--artifact-path obaas/myserv/target/accounts-0.0.1-SNAPSHOT.jar.exec --image-version 0.0.1
421+
--graalvm-native --java-version container-registry.oracle.com/os/oraclelinux:7-slim
419422
```
420423
421424
### create-autoscaler
@@ -428,7 +431,8 @@ NAME
428431
create-autoscaler - Create an autoscaler.
429432
430433
SYNOPSIS
431-
create-autoscaler --app-name String [--service-name String] --min-replicas int --max-replicas int --cpu-percent int --help
434+
create-autoscaler --app-name String [--service-name String] --min-replicas int
435+
--max-replicas int --cpu-request String --cpu-percent int --help
432436
433437
OPTIONS
434438
--app-name String
@@ -447,6 +451,10 @@ OPTIONS
447451
The maximum number of replicas
448452
[Optional, default = 4]
449453
454+
--cpu-request String
455+
The amount of CPU to request
456+
[Optional, default = 100m]
457+
450458
--cpu-percent int
451459
The CPU percent at which to scale
452460
[Optional, default = 80]
@@ -456,6 +464,10 @@ OPTIONS
456464
[Optional]
457465
458466
467+
468+
CURRENTLY UNAVAILABLE
469+
you are not signedIn. Please sign in to be able to use this command!
470+
459471
Ask for Help
460472
Slack: https://oracledevs.slack.com/archives/C03ALDSV272
461473
E-mail: obaas_ww@oracle.com
@@ -464,11 +476,12 @@ Ask for Help
464476
For example:
465477
466478
```bash
467-
oractl:>create-autoscaler --app-name application --service-name creditscore --cpu-percent 80 --min-replicas 2 --max-replicas 6
479+
oractl:>create-autoscaler --app-name application --service-name creditscore --cpu-percent 80
480+
--cpu-request 200m --min-replicas 2 --max-replicas 6
468481
obaas-cli [create-autoscaler]: Autoscaler was successfully created.
469482
```
470483
471-
You can view the details of the autoscaler using `kubectl`, for example:
484+
You can view the details of the autoscaler using `kubectl`, for example:
472485
473486
```bash
474487
$ kubectl -n application get hpa
@@ -579,7 +592,8 @@ NAME
579592
config - View and modify Service configuration.
580593
581594
SYNOPSIS
582-
config [--action CommandConstants.ConfigActions] --service-name String --service-label String --service-profile String --property-key String --property-value String --artifact-path String --help
595+
config [--action CommandConstants.ConfigActions] --service-name String --service-label String
596+
--service-profile String --property-key String --property-value String --artifact-path String --help
583597
584598
OPTIONS
585599
--action CommandConstants.ConfigActions
@@ -624,7 +638,8 @@ Ask for Help
624638
* Add a specific configuration using the set of parameters `--service-name`, `--service-label`, `--service-profile`, `--property-key`, and `--property-value`. For example:
625639
626640
```bash
627-
oractl:>config add --service-name myserv --service-label 0.0.1 --service-profile default --property-key k1 --property-value value1
641+
oractl:>config add --service-name myserv --service-label 0.0.1 --service-profile default
642+
--property-key k1 --property-value value1
628643
Property added successfully.
629644
```
630645
@@ -997,7 +1012,7 @@ Manage users allows you to create the platform users and assign the roles that g
9971012
9981013
Use the `user create` command to add users to the platform. This command requires the name of the user `username` and the user roles in a comma-separated list.
9991014
1000-
```bash
1015+
```text
10011016
oractl:>help user create
10021017
NAME
10031018
user create - Creates a new user in your platform.
@@ -1007,7 +1022,7 @@ SYNOPSIS
10071022
10081023
OPTIONS
10091024
--username String
1010-
The name you assign to the user during creation. This is the users login for the CLI and for the SOC UI, also. The name must be unique across all users in the platform and cannot be changed.
1025+
The name you assign to the user during creation. This is the user's login for the CLI and for the SOC UI, also. The name must be unique across all users in the platform and cannot be changed.
10111026
[Mandatory]
10121027
10131028
--roles String
@@ -1161,7 +1176,7 @@ oractl:>user list
11611176
11621177
Use the `user delete` command to remove users from the platform.
11631178
1164-
> ATTENTION: Ensure that you want to completely delete the user. You cannot rollback the user profile once deleted.
1179+
> NOTE: User deletion is permanent and irreversible.
11651180
11661181
```bash
11671182
oractl:>help user delete

docs-source/spring/content/development/envvars.md

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,43 @@ When you deploy a Spring Boot application using the Oracle Backend for Spring Bo
88

99
The predefined variables are as follows:
1010

11-
Variable name | Example value | Notes
12-
---------------------------------------|----------------|---------
13-
`app.container.port` | `8080` | This sets the listen port for the pod and service. The Spring Boot application will listen on this port. The default is `8080`. This can be set using the `--port` parameter on the `deploy` command in the CLI.
14-
`spring.profiles.active` | `default` | This sets the Spring profiles that will be active in the application. The default value is `default`. This can be changed set the `--service-profile` parameter on the `deploy` command in the CLI.
15-
`spring.config.label` | `0.0.1` | This is a label that can be used with Spring Config to look up externalized configuration from Spring Config Server, along with the application name and the profile.
16-
`eureka.instance.preferIpAddress` | `true` | This tells the Eureka discovery client to use the `preferIpAddress` setting. This is required in Kubernetes so that service discover will work correctly.
17-
`eureka.instance.hostname` | `customer32.application` | This sets the hostname that Eureka will use for this application.
18-
`MP_LRA_COORDINATOR_URL` | `http://otmm-tcs.otmm.svc.cluster.local:9000/api/v1/lra-coordinator` | This is the URL for the transaction manager which is required when using Eclipse Microprofile Long Running Actions in your application.
19-
`MP_LRA_PARTICIPANT_URL` | `http://customer32.application.svc.cluster.local:8080` | This is the participant URL which is required when using Eclipse Microprofile Long Running Actions in your application.
20-
`eureka.client.register-with-eureka` | `true` | This tells the Eureka discovery client to register with the Eureka server.
21-
`eureka.client.fetch-registry` | `true` | This tells the Eureka discovery client to make a local copy of the registry by fetching it from the Eureka server.
22-
`eureka.client.service-url.defaultZone` | `http://eureka.eureka:8761/eureka` | This is the default zone for the Eureka discovery client.
23-
`zipkin.base-url` | `http://jaegertracing-collector.observability.svc.cluster.local:9411/api/v2/spans` | This is the URL of the Zipkin-compatible trace collector which can be used by your application to send trace data to the platform.
24-
`otel.exporter.otlp.endpoint` | `http://open-telemetry-opentelemetry-collector.open-telemetry:4318/v1/traces` | This is the URL of the OpenTelemetry (OTLP protocol) trace collector which can be used by your application to send trace data to the platform.
25-
`config.server.url` | `http://config-server.config-server.svc.cluster.local:8080` | This is the URL of the Spring Config Server provided by the platform.
26-
`liquibase.datasource.username` | set to the key `db.username` in secret `admin-liquibasedb-secrets` | This sets the (admin) user that should be used to run Liquibase, if used in your service.
27-
`liquibase.datasource.password` | set to the key `db.password` in secret `admin-liquibasedb-secrets` | This sets the (admin) user's password that should be used to run Liquibase, if used in your service.
28-
`spring.datasource.username` | set to the key `db.username` in secret `customer32-db-secrets` | This sets the (regular) user for your application to use to connect to the database (if you use JPA or JDBC in your application).
29-
`spring.datasource.password`: | set to the key `db.password` in secret `customer32-db-secrets` | This sets the (regular) user's password for your application to use to connect to the database (if you use JPA or JDBC in your application).
30-
`DB_SERVICE` | set to the key `db.service` in secret `customer32-db-secrets` | This sets the database service name (the TNS name) for your application to use to connect to the database (if you use JPA or JDBC in your application).
31-
`spring.datasource.url` | `jdbc:oracle:thin:@$(DB_SERVICE)?TNS_ADMIN=/oracle/tnsadmin` | This sets the data source URL for your application to use to connect to the database (if you use JPA or JDBC in your application).
32-
`CONNECT_STRING` | `jdbc:oracle:thin:@$(DB_SERVICE)?TNS_ADMIN=/oracle/tnsadmin` | This sets the data source URL for your application to use to connect to the database (if you use JPA or JDBC in your application).
11+
- `app.container.port`, for example `8080`.
12+
This sets the listen port for the pod and service. The Spring Boot application will listen on this port. The default is `8080`. This can be set using the `--port` parameter on the `deploy` command in the CLI.
13+
- `spring.profiles.active`, for example `default`.
14+
This sets the Spring profiles that will be active in the application. The default value is `default`. This can be changed set the `--service-profile` parameter on the `deploy` command in the CLI.
15+
- `spring.config.label`, for example `0.0.1`.
16+
This is a label that can be used with Spring Config to look up externalized configuration from Spring Config Server, along with the application name and the profile.
17+
- `eureka.instance.preferIpAddress`, for example `true`.
18+
This tells the Eureka discovery client to use the `preferIpAddress` setting. This is required in Kubernetes so that service discover will work correctly.
19+
- `eureka.instance.hostname`, for example `customer32.application`.
20+
This sets the hostname that Eureka will use for this application.
21+
- `MP_LRA_COORDINATOR_URL`, for example `http://otmm-tcs.otmm.svc.cluster.local:9000/api/v1/lra-coordinator`.
22+
This is the URL for the transaction manager which is required when using Eclipse Microprofile Long Running Actions in your application.
23+
- `MP_LRA_PARTICIPANT_URL`, for example `http://customer32.application.svc.cluster.local:8080`.
24+
This is the participant URL which is required when using Eclipse Microprofile Long Running Actions in your application.
25+
- `eureka.client.register-with-eureka`, for example `true`.
26+
This tells the Eureka discovery client to register with the Eureka server.
27+
- `eureka.client.fetch-registry`, for example `true`.
28+
This tells the Eureka discovery client to make a local copy of the registry by fetching it from the Eureka server.
29+
- `eureka.client.service-url.defaultZone`, for example `http://eureka.eureka:8761/eureka`.
30+
This is the default zone for the Eureka discovery client.
31+
- `zipkin.base-url`, for example `http://jaegertracing-collector.observability.svc.cluster.local:9411/api/v2/spans`.
32+
This is the URL of the Zipkin-compatible trace collector which can be used by your application to send trace data to the platform.
33+
- `otel.exporter.otlp.endpoint`, for example `http://open-telemetry-opentelemetry-collector.open-telemetry:4318/v1/traces`.
34+
This is the URL of the OpenTelemetry (OTLP protocol) trace collector which can be used by your application to send trace data to the platform.
35+
- `config.server.url`, for example `http://config-server.config-server.svc.cluster.local:8080`.
36+
This is the URL of the Spring Config Server provided by the platform.
37+
- `liquibase.datasource.username`, for example set to the key `db.username` in secret `admin-liquibasedb-secrets`.
38+
This sets the (admin) user that should be used to run Liquibase, if used in your service.
39+
- `liquibase.datasource.password`, for example set to the key `db.password` in secret `admin-liquibasedb-secrets`.
40+
This sets the (admin) user's password that should be used to run Liquibase, if used in your service.
41+
- `spring.datasource.username`, for example set to the key `db.username` in secret `customer32-db-secrets`.
42+
This sets the (regular) user for your application to use to connect to the database (if you use JPA or JDBC in your application).
43+
- `spring.datasource.password`:, for example set to the key `db.password` in secret `customer32-db-secrets`.
44+
This sets the (regular) user's password for your application to use to connect to the database (if you use JPA or JDBC in your application).
45+
- `DB_SERVICE`, for example set to the key `db.service` in secret `customer32-db-secrets`.
46+
This sets the database service name (the TNS name) for your application to use to connect to the database (if you use JPA or JDBC in your application).
47+
- `spring.datasource.url`, for example `jdbc:oracle:thin:@$(DB_SERVICE)?TNS_ADMIN=/oracle/tnsadmin`.
48+
This sets the data source URL for your application to use to connect to the database (if you use JPA or JDBC in your application).
49+
- `CONNECT_STRING`, for example `jdbc:oracle:thin:@$(DB_SERVICE)?TNS_ADMIN=/oracle/tnsadmin`.
50+
This sets the data source URL for your application to use to connect to the database (if you use JPA or JDBC in your application).

0 commit comments

Comments
 (0)