Skip to content

Commit aa41013

Browse files
IntelliJ Plugin Update (#993)
Signed-off-by: Anders Swanson <anders.swanson@oracle.com>
1 parent 6493482 commit aa41013

14 files changed

+56
-12
lines changed

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

Lines changed: 56 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ See the Oracle Free Use Terms and Conditions [License](https://oss.oracle.com/li
3535

3636
### Proxy Configuration
3737

38-
If you are connecting to your Kubernetes cluster through a proxy server, configure your IntelliJ proxy settings from Settings -> Proxy. Th Oracle Backend for Microservices and AI will use your IntelliJ system proxy settings to connect to your Kubernetes cluster.
38+
If you are connecting to your Kubernetes cluster through a proxy server, configure your IntelliJ proxy settings from Settings -> Proxy. The Oracle Backend for Microservices and AI will use your IntelliJ system proxy settings to connect to your Kubernetes cluster.
3939

4040
## Configuring the Oracle Backend for Microservices and AI Connection
4141

@@ -78,6 +78,7 @@ Once you are connected to Oracle Backend for Microservices and AI, click on the
7878
- Oracle Backend for Microservices and AI namespaces are shown in the "namespaces" section, each namespace containing a list of applications.
7979
- Links to platform service dashboards are shown in the "platform services" section.
8080
- Configuration properties are listed in the "configuration" section.
81+
- Platform images built with OBaaS.
8182
8283
![explore-resources](./images/explore-resources.png)
8384
@@ -91,28 +92,67 @@ To create a new namespace, right click on the namespace and select "Add Namespac
9192
9293
After you click OK, the namespace will be created and appear in the namespace list in a few moments.
9394
94-
![namespace-created](./images/namespace-created.png)
95+
![namespace-created](./images/new-namespace.png)
9596
9697
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.
9798
98-
### Deploying workloads into namespaces
99+
### Creating a datastore to bind workloads to the database
99100
100-
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.
101+
All OBaaS workloads that connect to the database require a datastore reference, or binding. Each datastore represents an Oracle Database user, and one or more workloads may be bound to the same datastore.
101102
102-
On the Add Workload form, enter workload data.
103-
- Database username will default to the workload name if not specified, and is used for Java Message Service Transactional Event Queue authentication.
103+
To create a datastore, right click a namespace and click "Add Datastore".
104104
105-
![upload-jar](./images/upload-jar.png)
105+
![add-datastore](./images/add-datastore.png)
106106
107-
When you click OK, the JAR/exec file will be uploaded to Oracle Backend for Microservices and AI, 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.
107+
Enter a datastore ID, username, and password, and then click OK to create the datastore. The username and password must be valid for Oracle Database.
108108
109-
### Workload autoscalers
109+
![datastore-dialogue](./images/datastore-dialogue.png)
110110
111-
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.
111+
The new datastore `my-ds` should be visible as a red database icon in the `my-app` namespace. Once a datastore is created, you may right-click that datastore to delete it, or to update the datastore password. Note that password updates may require a workload restart to resume database connectivity.
112112

113-
![create-autoscaler](./images/create-autoscaler.png)
113+
![new-datastore](./images/new-datastore.png)
114114

115-
You may also deletea workload's autoscaler from the workload context menu.
115+
### Creating a workload
116+
117+
To deploy a workload into a namespace, right click that namespace and select "Add Workload".
118+
119+
![add-workload](./images/add-workload.png)
120+
121+
On the Add Workload form, you'll be prompted to enter information about the workload.
122+
123+
- Name: The name or ID of the workload.
124+
- Profile: The active Spring profile.
125+
- Initial Replicas: How many replicas of the workload to create.
126+
- Port: The workload's application port.
127+
- Add health probe: Whether to add liveness and readiness probes.
128+
- CPU Request: How much CPU to request for the workload. 500m = 1/2 core.
129+
- Image version: The version or tag of the workload image.
130+
- Workload artifact: Path to the workload's JAR or native binary on your system.
131+
- Base image: The base image used when building the workload image.
132+
- Datastore: the datastore to use for database connectivity.
133+
- Liquibase username: Optional username for Liquibase scripts.
134+
135+
Note that you may leave the datastore dropdown blank if your workload does not require access to the database.
136+
137+
![workload-dialogue](./images/workload-dialogue.png)
138+
139+
When you click OK, the JAR or binary file will be uploaded to Oracle Backend for Microservices and AI, 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.
140+
141+
Once the task is complete, the workload will appear under the namespace it was created in. If you bound your workload to a datastore, an icon representing that binding will appear under the workload.
142+
143+
![new-workload](./images/new-workload.png)
144+
145+
Once a workload has been created, it can be updated or deleted by right-clicking that workload and selecting "Update Workload" or "Delete Workload".
146+
147+
For Update, if you do not specify a new base image and workload artifact, only the workload's parameters, such as Replicas, will be updated.
148+
149+
### Autoscaling workloads
150+
151+
To create an autoscaler for a workload, right-click the workload and select "Autoscaling". Autoscalers are configured on the workload's percent CPU utilization, specifying minimum and maximum autoscaling replicas.
152+
153+
![create-autoscaler](./images/autoscaling.png))
154+
155+
To update an autoscaler, click right-click a workload and select "Autoscaling" again. The same form will appear, allowing you to edit values. You may also delete a workload's autoscaler from the workload context menu.
116156

117157
### Publishing workloads
118158

@@ -135,3 +175,7 @@ Once the connection is complete, click the "Open console" link on the completion
135175
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.
136176

137177
A property is associated with a given configuration service, and may have a label, profile, key, and value.
178+
179+
## Platform Images
180+
181+
Successfully created platform images can be browsed through the "platform images" section. These images are informational references to built images, not images from container registry.
Loading
Loading
Loading
Binary file not shown.
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)