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
Copy file name to clipboardExpand all lines: docs-source/spring/content/platform/vscode-plugin/_index.md
+29-32Lines changed: 29 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: "Visual Studio Code extension for Oracle Backend for Spring Boot an
4
4
keywords: "vscode code visualstudio extension springboot spring development microservices development oracle backend"
5
5
---
6
6
7
-
**GA 1.0 - October, 2023**
7
+
**GA 1.1.1 - February, 2024**
8
8
9
9
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.
10
10
@@ -20,7 +20,7 @@ You must have already installed and configured the following software which requ
20
20
21
21
## Installation
22
22
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).
24
24
25
25
2. On the VS Code left menu bar, click on the **Extensions** symbol:
26
26
@@ -69,7 +69,7 @@ services, you cannot browse resources included in the Oracle Backend for Spring
69
69
70
70
1. Select the cluster and right-click, choosing **Set UID/PWD** menu item to insert credentials related to your user account. For example:
71
71
72
-

72
+

73
73
74
74
2. Specify the **OBSBM Admin ID** for the Oracle Backend for Spring Boot and Microservices user for deployment. For example:
75
75
@@ -103,11 +103,6 @@ services, you cannot browse resources included in the Oracle Backend for Spring
103
103
104
104
7. Select the cluster again and right-click **Connect**. This creates a session with the credentials set up in the first step.
105
105
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
-

109
-
110
-
111
106
### Explore Resources
112
107
113
108
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
117
112
You see four top classes of resources that can be expanded in underlying items:
118
113
119
114
***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.
121
116
***platformServices** : The list of Oracle Backend for Spring Boot and Microservices deployed services, like Grafana, Spring, Apache APISIX, Eureka and Jaeger.
122
117
***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.
123
118
@@ -219,23 +214,17 @@ Choosing this item menu, the parameters will be required are:
11.**Add Health probe? : [True]/[False]** (Default: `True`)
227
+
10.**Add Health probe? : [True]/[False]** (Default: `True`)
239
228
240
229
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.
241
230
@@ -247,31 +236,27 @@ Choosing this item menu, selecting a single application, the parameters will be
247
236
248
237
1. A popup dialog box opens to select the local Spring Boot **.jar file**
249
238
250
-
2.**Do you want to bind a schema? : [True]/[False]** (Default: `True`)
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`)
263
248
264
-
9.**Service Port** (Default: `8080`)
249
+
8.**Service Port** (Default: `8080`)
265
250
266
-
10.**Service Profile** (Default: `obaas`)
251
+
9.**Service Profile** (Default: `obaas`)
267
252
268
-
11.**Initial Replicas** (Default: `1`)
253
+
10.**Initial Replicas** (Default: `1`)
269
254
270
-
12.**Inform the database name for Liquibase**: username for Liquibase.
255
+
11.**Inform the database name for Liquibase**: username for Liquibase.
271
256
272
257
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.
273
258
274
-
#### Bind a Service
259
+
#### Bind a service
275
260
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.
276
261
The parameters required are:
277
262
@@ -287,13 +272,25 @@ This command removes the application and all the services included. At the end o
287
272
### Service level commands
288
273
With a right click on a single service you will have the following commands:
289
274
275
+
***Create autoscaler**
276
+
***Delete autoscaler**
290
277
***Delete service**
291
278
***Publish service**
292
279
293
280
as shown here:
294
281
295
282

296
283
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
+
297
294
#### Delete service
298
295
Selecting the service from the tree, under a specific application, you will remove the service deployment, and the active pods will be removed.
299
296
@@ -317,7 +314,7 @@ A successful operation will return the Route ID recorded into the APISix, as sho
317
314
This is a shortcut with a standard registration: to customize the route, or start from scratch, is suggested the usage of APISix console.
318
315
319
316
320
-
## ADB Database
317
+
## Oracle DB
321
318
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.
0 commit comments