Skip to content

Commit d7bcf74

Browse files
Corradodebari patch vs code ext (#825)
* update to last VS Code ext --------- Co-authored-by: Mark Nelson <mark.x.nelson@oracle.com>
1 parent 898f6ff commit d7bcf74

File tree

5 files changed

+29
-32
lines changed

5 files changed

+29
-32
lines changed

docs-source/spring/content/platform/vscode-plugin/_index.md

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Visual Studio Code extension for Oracle Backend for Spring Boot an
44
keywords: "vscode code visualstudio extension springboot spring development microservices development oracle backend"
55
---
66

7-
**GA 1.0 - October, 2023**
7+
**GA 1.1.1 - February, 2024**
88

99
Oracle Backend for Spring Boot and Microservices Visual Studio Code (VS Code) plugin is an extension to browse and deploy applications on the Oracle Backend for Spring Boot and Microservices platform. This plugin inspects the content of an Oracle Backend for Spring Boot and Microservices deployment, in terms of applications, services, and related configurations. It simplifies access to the installed platform services (like Grafana, Spring, Apache APISIX, Eureka, and Jaeger) creating `ssh` tunnels on-demand and providing access to their respective web administrator consoles. It adds credentials to access and bind services to the Oracle Database included in the Oracle Backend for Spring Boot and Microservices deployment. This plugin replicates the functionalities available in [OBaas CLI](../../development/cli) and simplifies access to Oracle Backend for Spring Boot and Microservices deployments from an integrated development environment (IDE) like VS Code.
1010

@@ -20,7 +20,7 @@ You must have already installed and configured the following software which requ
2020

2121
## Installation
2222

23-
1. Download the plug-in from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.0.0).
23+
1. Download the plug-in from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.0).
2424

2525
2. On the VS Code left menu bar, click on the **Extensions** symbol:
2626

@@ -69,7 +69,7 @@ services, you cannot browse resources included in the Oracle Backend for Spring
6969

7070
1. Select the cluster and right-click, choosing **Set UID/PWD** menu item to insert credentials related to your user account. For example:
7171

72-
![Credentials](./images/credentials.jpg)
72+
![Credentials](./images/credentials.png)
7373

7474
2. Specify the **OBSBM Admin ID** for the Oracle Backend for Spring Boot and Microservices user for deployment. For example:
7575

@@ -103,11 +103,6 @@ services, you cannot browse resources included in the Oracle Backend for Spring
103103

104104
7. Select the cluster again and right-click **Connect**. This creates a session with the credentials set up in the first step.
105105

106-
8. If your intention is to use the service provided by the Oracle Backend for Spring Boot and Microservice to compile the Spring Boot application via GraalVM and run a native service, you have to open another tunnel to the GraalVM compiler, choosing from the same menu used so far the **Create GraalVM tunnel** item. The final status should be as shown in this picture:
107-
108-
![okTunnels](./images/graalvmtunnel.jpg)
109-
110-
111106
### Explore Resources
112107

113108
When the steps to create the tunnel are completed and you are connected to the backend, it is possible to expand and **Refresh** the tree related to the deployment. For example:
@@ -117,7 +112,7 @@ When the steps to create the tunnel are completed and you are connected to the b
117112
You see four top classes of resources that can be expanded in underlying items:
118113

119114
* **applications** : The list of applications deployed and the holding services.
120-
* **ADB database** : In this release there is one Oracle Database in which the configurations and schemas related to deployed services are stored.
115+
* **Oracle DB** : In this release there is one Oracle Database in which the configurations and schemas related to deployed services are stored.
121116
* **platformServices** : The list of Oracle Backend for Spring Boot and Microservices deployed services, like Grafana, Spring, Apache APISIX, Eureka and Jaeger.
122117
* **oBaasConf** : The list of keys defined by the applications, stored in the Oracle Database, that are provisioned and available to share configurations information among services in each application.
123118

@@ -219,23 +214,17 @@ Choosing this item menu, the parameters will be required are:
219214

220215
2. **Service Name**
221216

222-
3. **Spring Binding Prefix** (Default: `spring.datasource`)
223-
224-
4. **Do you want to bind a schema? : [True]/[False]** (Default: `True`)
225-
226-
5. **Bind :[True]/[False]** (Default: `True`)
217+
3. **Bind [jms]** (Default: ``)
227218

228219
6. **Service Port** (Default: `8080`)
229220

230221
7. **Service Profile** (Default: `obaas`)
231222

232-
8. **Image Version** (Default: `0.1`)
223+
8. **Image Version** (Default: `0.0.1`)
233224

234225
9. **Initial Replicas** (Default: `1`)
235226

236-
10. **Redeploy?: [True]/[False]** (Default: `True`)
237-
238-
11. **Add Health probe? : [True]/[False]** (Default: `True`)
227+
10. **Add Health probe? : [True]/[False]** (Default: `True`)
239228

240229
At the end of the parameters collection, a process, that includes the .exec file upload, building image and deploying, starts. It generates a sequence of messages showing the status. These messages end with "Service deployed successfully!" or "Deploy failed". The size and network constraints determine the amount of time for the process to terminate.
241230

@@ -247,31 +236,27 @@ Choosing this item menu, selecting a single application, the parameters will be
247236

248237
1. A popup dialog box opens to select the local Spring Boot **.jar file**
249238

250-
2. **Do you want to bind a schema? : [True]/[False]** (Default: `True`)
251-
252-
3. **Service Name**
239+
2. **Service Name**
253240

254-
4. **Spring Binding prefix** (Default: `spring.datasource`)
241+
3. **Bind [jms]** (Default: ``)
255242

256-
5. **Image Version** (Default: `0.1`)
243+
5. **Image Version** (Default: `0.0.1`)
257244

258245
6. **Java image** (Default: `ghcr.io/graalvm/jdk:ol7-java17-22.2.0`)
259246

260-
7. **is it a redeploy? : [True]/[False]** (Default: `True`)
261-
262-
8. **Add Health probe? : [True]/[False]** (Default: `True`)
247+
7. **Add Health probe? : [True]/[False]** (Default: `True`)
263248

264-
9. **Service Port** (Default: `8080`)
249+
8. **Service Port** (Default: `8080`)
265250

266-
10. **Service Profile** (Default: `obaas`)
251+
9. **Service Profile** (Default: `obaas`)
267252

268-
11. **Initial Replicas** (Default: `1`)
253+
10. **Initial Replicas** (Default: `1`)
269254

270-
12. **Inform the database name for Liquibase**: username for Liquibase.
255+
11. **Inform the database name for Liquibase**: username for Liquibase.
271256

272257
At the end of the parameters collection, a process, that includes the .jar upload, building image and deploying, starts. It generates a sequence of messages showing the status. These messages end with "Service deployed successfully!" or "Deploy failed". The size and network constraints determine the amount of time for the process to terminate.
273258

274-
#### Bind a Service
259+
#### Bind a service
275260
This command create/update a user on the Oracle DB according the service name typed, or optionally to a different user schema, to which bind a Spring Boot microservice that will store data into the DB. It also store secrets with the user credentials into the application namespace, in order to inject them into the related pods. If the schema exists, it impose to change the user password will be stored in the namespace.
276261
The parameters required are:
277262

@@ -287,13 +272,25 @@ This command removes the application and all the services included. At the end o
287272
### Service level commands
288273
With a right click on a single service you will have the following commands:
289274

275+
* **Create autoscaler**
276+
* **Delete autoscaler**
290277
* **Delete service**
291278
* **Publish service**
292279

293280
as shown here:
294281

295282
![Service Commands](./images/servicecommands.jpg)
296283

284+
#### Create autoscaler
285+
Create a Kubernetes autoscaler for the selected pod.
286+
1. **minReplicas** (Default: `1`)
287+
2. **maxReplicas** (Default: `1`)
288+
3. **cpuPercent** (Default: ``)
289+
4. **cpuRequest** (Default: `100m`)
290+
291+
#### Delete autoscaler
292+
Delete an existing autoscaler
293+
297294
#### Delete service
298295
Selecting the service from the tree, under a specific application, you will remove the service deployment, and the active pods will be removed.
299296

@@ -317,7 +314,7 @@ A successful operation will return the Route ID recorded into the APISix, as sho
317314
This is a shortcut with a standard registration: to customize the route, or start from scratch, is suggested the usage of APISix console.
318315

319316

320-
## ADB Database
317+
## Oracle DB
321318
For each Oracle Backend for Spring Boot and Microservices, an Oracle Autonomous Transaction Processing database is provisioned on OCI to hold the schema for the Spring Boot services and backend's configuration details. The icon remembers the component deployed with the backend platform.
322319

323320
## platformServices
Loading
Binary file not shown.
Loading
Loading

0 commit comments

Comments
 (0)