Skip to content

Commit f5689a6

Browse files
Intellij plugin (#933)
* IntelliJ Plugin Documentation --------- Signed-off-by: Anders Swanson <anders.swanson@oracle.com>
1 parent d3cdddc commit f5689a6

18 files changed

+125
-5
lines changed

docs-source/spring/content/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Developers also have access to development or build time services and libraries
4747

4848
- A command-line interface [(CLI)](development/cli/) to manage service deployment and configuration, including database schema management.
4949
- [Visual Studio Code (VS Code) plugin](platform/vscode-plugin/) to manage service deployment and configuration.
50+
- [IntelliJ plugin](platform/intellij-plugin/) to manage service deployment and configuration.
5051
- [Spring CLI](https://spring.io/projects/spring-cli) support for project creation.
5152
- Spring Data (Java Persistence API (JPA) and Oracle JDBC) to access Oracle Database.
5253
- Oracle Java Database Connectivity (Oracle JDBC) drivers.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ For more details, read about:
1717
- [Using the CLI](../development/cli)
1818
- [MicroTx](./microtx)
1919
- [Vault](./vault/)
20+
- [VS Code Plugin](./vscode-plugin)
21+
- [IntelliJ Plugin](./intellij-plugin)
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
title: "Oracle Backend for Spring Boot and Microservices IntelliJ Plugin"
3+
description: "IntelliJ Plugin for Oracle Backend for Spring Boot and Microservices"
4+
keywords: "intellij plugin ide springboot spring development microservices development oracle backend"
5+
---
6+
7+
## GA 1.3.0 - September, 2024
8+
9+
Oracle Backend for Spring Boot and Microservices (OBaaS) is an IntelliJ plugin to browse, deploy, and modify workloads on the Oracle Backend for Spring Boot and Microservices platform.This plug-in implements the functionalities available in the [Oracle Backend for Spring Boot and Microservices CLI](../../development/cli), simplifying access to Oracle Backend for Spring Boot and Microservices deployments from an IntelliJ IDE.
10+
11+
The plug-in allows access to the Oracle Backend for Spring Boot and Microservices platform services, including the Grafana, Spring, APISIX, Eureka and Jaeger web admin consoles. Additionally, you may create and bind workloads to your Oracle Backend for Spring Boot and Microservices database deployment. Users may inspect Oracle Backend for Spring Boot and Microservices deployment namespaces, workloads, and related configuration.
12+
13+
See the Oracle Free Use Terms and Conditions [License](https://oss.oracle.com/licenses/upl/)
14+
15+
## Prerequisites
16+
17+
* An operational Oracle Backend for Spring Boot and Microservices deployment, as configured through platform [setup](../../setup/).
18+
* Access to a Kubernetes cluster where Oracle Backend for Spring Boot and Microservices is deployed from your IntelliJ IDE.
19+
20+
## Installation
21+
22+
1. Download the IntelliJ plugin ZIP file from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.3.0).
23+
24+
2. On the IntelliJ Settings plugins page, click the "gear" icon and select **Install Plugin from Disk...**. Browse your filesystem for the IntelliJ plugin ZIP file, and select it.
25+
26+
![plugin-intell](./images/install-from-disk.png)
27+
28+
3. Click **OK**, and restart your IDE to load the Oracle Backend for Spring Boot and Microservices plugin.
29+
30+
4. If you do not see the Oracle Backend for Spring Boot and Microservices icon on your IDE's toolbar, navigate to View -> Tool Windows, and select "OBaaS" to add it to your IDE's tool window bar.
31+
32+
## Configuring the Oracle Backend for Spring Boot and Microservices Connection
33+
34+
1. Open the plugin tool window by clicking the "OBaaS" icon on the IntelliJ tool bar, and click the "wrench" icon to open the Oracle Backend for Spring Boot and Microservices connection settings.
35+
36+
![open-settings](./images/open-settings.png)
37+
38+
2. Enter the Oracle Backend for Spring Boot and Microservices username, password, kubeconfig for the Kubernetes cluster, and the local port the Oracle Backend for Spring Boot and Microservices admin tunnel will bind to. The default kubeconfig and context may already be selected.
39+
40+
![plugin-settings](./images/settings.png)
41+
42+
3. When you're done, click "Test Connection" to verify the Oracle Backend for Spring Boot and Microservices connectivity. If you've configured your kubeconfig and Oracle Backend for Spring Boot and Microservices credentials correctly, you should see a connection successful message:
43+
44+
![test-connection](./images/test-connection.png)
45+
46+
### Managing Oracle Backend for Spring Boot and Microservices Connection States
47+
48+
To refresh the Oracle Backend for Spring Boot and Microservices connection, click the "Refresh" button at the top of the Oracle Backend for Spring Boot and Microservices tool window.
49+
50+
To cancel all active connections, click the red "Close Connections" button at the top of the Oracle Backend for Spring Boot and Microservices tool window.
51+
52+
## Explore Oracle Backend for Spring Boot and Microservices Resources
53+
54+
Once you are connected to Oracle Backend for Spring Boot and Microservices, click on the context node in the tool window tree to view Oracle Backend for Spring Boot and Microservices resources in your cluster.
55+
56+
- Oracle Backend for Spring Boot and Microservices namespaces are shown in the "namespaces" section, each namespace containing a list of applications.
57+
- Links to platform service dashboards are shown in the "platform services" section.
58+
- Configuration properties are listed in the "configuration" section.
59+
60+
![explore-resources](./images/explore-resources.png)
61+
62+
## Working with namespaces and workloads
63+
64+
### Create a new namespace
65+
66+
To create a new namespace, right click on the namespace and select "Add Namespace".
67+
68+
![add-namespace](./images/add-namespace.png)
69+
70+
After you click OK, the namespace will be created and appear in the namespace list in a few moments.
71+
72+
![namespace-created](./images/namespace-created.png)
73+
74+
You can delete a namespace by right clicking on that namespace, and selecting "Delete Namespace". When a namespace is deleted, all applications in the namespace will also be deleted.
75+
76+
### Deploying workloads into namespaces
77+
78+
To deploy a workload into a namespace, right click that namespace and select "Add Workload -> Upload .jar" for JVM workloads or "Add Workload -> Upload .exec" for GraalVM native workloads.
79+
80+
On the Add Workload form, enter workload data.
81+
- Database username will default to the workload name if not specified, and is used for Java Message Service Transactional Event Queue authentication.
82+
83+
![upload-jar](./images/upload-jar.png)
84+
85+
When you click OK, the JAR/exec file will be uploaded to Oracle Backend for Spring Boot and Microservices, an image is built, and the workload deployed to the cluster namespace. The task duration will vary depending on the size of the upload file and your network connection for upload.
86+
87+
### Workload autoscalers
88+
89+
To create an autoscaler for a workload, right-click the workload and select "Create Autoscaler". Autoscalers are configured on workload CPU, and specify minimum and maximum scale replicas.
90+
91+
![create-autoscaler](./images/create-autoscaler.png)
92+
93+
You may also deletea workload's autoscaler from the workload context menu.
94+
95+
### Publishing workloads
96+
97+
A workload can be published on an APISIX route by right-clicking the workload, providing the APISIX admin key and the desired route.
98+
99+
![publish-workload](./images/publish-workload.png)
100+
101+
## Accessing Oracle Backend for Spring Boot and Microservices Platform Services
102+
103+
To access the web console of an Oracle Backend for Spring Boot and Microservices platform service (Grafana, Spring Admin, APISIX, Eureka, or Jaeger), right-click on the service's name under the "platform services" section and click "Connect".
104+
105+
![platform-services](./images/platform-services.png)
106+
107+
Once the connection is complete, click the "Open console" link on the completion message to navigate to the service's web console.
108+
109+
![grafana-connect](./images/grafana-connect.png)
110+
111+
## Configuration Properties
112+
113+
Workload configuration can be browsed and edited through the "configuration" section. To add a new configuration property, right-click either the top-level configuration section or a specific configuration node.
114+
115+
A property is associated with a given configuration service, and may have a label, profile, key, and value.
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)