Skip to content

Commit e2dea8a

Browse files
committed
Additional update to the Readme
1 parent 11e63e7 commit e2dea8a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

hols/oci-basic-setup/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,33 @@
33
This example demonstrates how to create a basic OCI infrastructure setup that can be used to deploy a Helidon MP OCI application.
44

55
## Objective
6-
1. Use Terraform to create automation of OCI resources provisioning that can build a basic OCI infrastructure setup composed of the following:
6+
1. Use Terraform to automate the provisioning of OCI resources that can build a basic OCI setup composed of the following:
77
1. OCI Compute instance with firewall opened at port 8080.
8-
2. OCI Virtual Cloud Network with Security List containing an Ingress at port 8080.
8+
2. OCI Virtual Cloud Network with a Security List containing an Ingress at port 8080.
99
3. Policies to allow OCI Logging and Monitoring services to be accessed from the provisioned OCI Compute instance.
1010
2. Generate a Helidon MP OCI project using Helidon cli.
11-
3. Use OCI cloud-shell to run this example through.
11+
3. Use OCI Cloud Shell to run this example through.
1212

1313
## Prerequisite
14-
- An OCI tenancy that has enough capacity to provision an OCI Compute instance and a Virtual Cloud Network. This will also work on the free trial of the [OCI Free Tier](https://docs.oracle.com/en-us/iaas/Content/FreeTier/freetier.htm).
14+
- An OCI tenancy that has enough capacity to provision an OCI Compute Instance and a Virtual Cloud Network (VCN). This will also work on the free trial of the [OCI Free Tier](https://docs.oracle.com/en-us/iaas/Content/FreeTier/freetier.htm).
1515

1616
## Tasks
1717
### Set up Cloud Shell access.
1818
1. If you are already a super-user with administrator rights that has access to all resources in the tenancy, skip to the next section. Otherwise, continue to the next step.
1919
2. Create a new group and add your user as a member of that group.
20-
3. Create a new policy and provide that group a cloud-shell access:
20+
3. Create a new policy and provide that group a Cloud Shell access:
2121
```
2222
Allow group '<my_cloud_shell_access_group>' to use cloud-shell in tenancy
2323
```
2424
4. Verify that it works by opening Cloud Shell from the OCI Console.
2525

2626
### Retrieve the oci-basic-setup subdirectory from the helidon-labs repository
27-
The materials for this exercise will be located in the [oci-basic-setup](https://github.com/helidon-io/helidon-labs/tree/main/hols/oci-basic-setup) subdirectory of the [helidon-labs](https://github.com/helidon-io/helidon-labs) repository, hence only that specific subdirectory will be cloned.
27+
The materials for this exercise are located in the [oci-basic-setup](https://github.com/helidon-io/helidon-labs/tree/main/hols/oci-basic-setup) subdirectory of the [helidon-labs](https://github.com/helidon-io/helidon-labs) repository, so only that specific subdirectory needs to be cloned.
2828
1. Open a Cloud Shell terminal and make sure you are in the home directory
2929
```shell
3030
cd ~
3131
```
32-
2. Use `git sparsecheckout` to check out only the `oci-basic-setup` directory from the helidon-labs repository.
32+
2. Use `git sparsecheckout` to check out only the `oci-basic-setup` directory from the `helidon-labs` repository.
3333
```shell
3434
git init helidon-labs
3535
cd helidon-labs
@@ -39,7 +39,7 @@ The materials for this exercise will be located in the [oci-basic-setup](https:/
3939
echo ".gitignore" >> .git/info/sparse-checkout
4040
git pull --depth=1 origin main
4141
```
42-
3. The previous step will pull all the required Terraform and Bash script files into the `~/helidon-labs/hols/oci-basic-setup` directory that will be needed to perform various operations to complete this exercise.
42+
3. The previous step pulls all the required Terraform and Bash script files into the `~/helidon-labs/hols/oci-basic-setup` directory that is required to perform the various operations in this exercise.
4343

4444
### Prepare the OCI infrastructure environment
4545
The goal of this task is to prepare a basic infrastructure environment comprised of a Compartment, Dynamic Groups, Policies, Compute and Virtual Cloud Network. This section requires a user with administrator privilege.
@@ -70,12 +70,12 @@ The goal of this task is to prepare a basic infrastructure environment comprised
7070
```shell
7171
cd ~
7272
```
73-
2. Download and unzip the helidon cli generic distribution
73+
2. Download and unzip the Helidon CLI generic distribution
7474
```shell
7575
curl -L -O https://github.com/helidon-io/helidon-build-tools/releases/download/3.0.6/helidon-cli.zip
7676
unzip helidon-cli.zip
7777
```
78-
3. Make sure that JDK 21 exist in the path.
78+
3. Make sure that JDK 21 exists in the path.
7979
4. Execute the cli to generate a Helidon Microprofile application project.
8080
```shell
8181
~/helidon-3.0.6/bin/helidon init
@@ -116,7 +116,7 @@ The goal of this task is to prepare a basic infrastructure environment comprised
116116
```shell
117117
~/helidon-labs/hols/oci-basic-setup/update_config_values.sh ~/oci-mp
118118
```
119-
Invoking this script will perform the following:
119+
Invoking this script performs the following:
120120
1. Updates the `~/oci-mp/server/src/main/resources/application.yaml` config file to set up a Helidon feature that sends Helidon generated metrics to the OCI monitoring service.
121121
1. compartmentId - The Compartment OCID used for this demo.
122122
2. namespace - This can be any string but for this demo, will be set to `helidon_metrics`.
@@ -125,7 +125,7 @@ The goal of this task is to prepare a basic infrastructure environment comprised
125125
2. oci.monitoring.namespace - This can be any string but for this demo, this will be set to `helidon_application`.
126126
3. oci.logging.id - Application log id that was provisioned by the terraform scripts.
127127

128-
**Note:** Make sure to validate that `application.yaml` and `microprofile-config.properties` have been updated by checking that the mentioned config parameters were properly populated.
128+
**Note:** Make sure to validate that `application.yaml` and `microprofile-config.properties` were updated by checking that the mentioned config parameters were properly populated.
129129
12. To prepare for the build, ensure that JDK 21 and Maven 3.8+ exist and are set in the PATH environment variable of the Cloud Shell terminal.
130130
13. Build the application.
131131
```shell
@@ -150,19 +150,19 @@ The goal of this task is to prepare a basic infrastructure environment comprised
150150
export ENDPOINT_IP=$(~/helidon-labs/hols/oci-basic-setup/get.sh public_ip)
151151
echo "Instance public ip is $ENDPOINT_IP"
152152
```
153-
2. Test Hello world request.
153+
2. Test the Hello world request.
154154
```shell
155155
curl http://$ENDPOINT_IP:8080/greet
156156
```
157-
results to:
157+
results in:
158158
```shell
159159
{"message":"Hello World!","date":[2025,4,29]}
160160
```
161161
3. Test Hello to a name, i.e. to `Joe`.
162162
```shell
163163
curl http://$ENDPOINT_IP:8080/greet/Joe
164164
```
165-
results to:
165+
results in:
166166
```shell
167167
{"message":"Hello Joe!","date":[2025,4,29]}
168168
```
@@ -171,7 +171,7 @@ The goal of this task is to prepare a basic infrastructure environment comprised
171171
curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://$ENDPOINT_IP:8080/greet/greeting
172172
curl http://$ENDPOINT_IP:8080/greet
173173
```
174-
results to:
174+
results in:
175175
```shell
176176
{"message":"Hola World!","date":[2025,4,29]}
177177
```
@@ -188,8 +188,8 @@ The goal of this task is to prepare a basic infrastructure environment comprised
188188
2. Change `Compartment` with a value that has the format of `devops-compartment-helidon-demo-<4 char random value>`.
189189
3. Under `Filters`, change `Log Group` to `app-log-group-helidon-demo`.
190190
4. Choose and click on `app-log-helidon-demo` from the Logs table.
191-
5. Choose `Filter by time` value within the scope of your last request. For example, you can choose `Today` to see all request that was made today.
192-
6. The `Explore Log` display should output some graphs of the logging activity and below it will also show a list of the logs that has been captured.
191+
5. Choose `Filter by time` value within the scope of your last request. For example, you can choose `Today` to see all requests that were made today.
192+
6. The `Explore Log` display should output graphs of the logging activity. Below the graphs, it will also show a list of the logs that have been captured.
193193
194194
### Cleanup
195195
When the environment is no longer needed, all the OCI resources can be cleaned up by following these steps:

0 commit comments

Comments
 (0)