Skip to content

Commit c8ceb28

Browse files
authored
Minor changes
1 parent d4f0962 commit c8ceb28

File tree

1 file changed

+21
-20
lines changed
  • oci-build-examples/oci_devops_graalee_micronaut

1 file changed

+21
-20
lines changed

oci-build-examples/oci_devops_graalee_micronaut/README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Using GraalVM Enterprise in OCI DevOps to build a Micronaut REST App
22

3-
This sample shows how to use `Oracle GraalVM Enterprise Edition` in `OCI DevOps build pipelines` build pipelines to build a simple Micronaut hello world REST application. You can use this approach to build any high-performance Java application with Micronaut, GraalVM Enterprise and OCI DevOps.
3+
This sample shows how to use `Oracle GraalVM Enterprise Edition` in `OCI DevOps build pipelines` to build a simple Micronaut hello world REST application. You can use this approach to build any high-performance Java application with Micronaut, GraalVM Enterprise and OCI DevOps.
44

55
## What is GraalVM?
66

@@ -12,7 +12,7 @@ This sample shows how to use `Oracle GraalVM Enterprise Edition` in `OCI DevOps
1212

1313
## What is Micronaut
1414

15-
- Micronaut is a modern, JVM-based framework to build modular, easily testable microservice and serverless applications. By avoiding runtime reflection in favour of annotation processing, Micronaut improves the Java-based development experience by detecting errors at compile time instead of runtime and improves Java-based application start time and memory footprint. Micronaut includes a persistence framework called Micronaut Data that precomputes your SQL queries at compilation time making it a great fit for working with databases like MySQL, Oracle Autonomous Database, etc.
15+
- Micronaut is a modern, JVM-based framework to build modular, easily testable microservice and serverless applications. By avoiding runtime reflection in favour of annotation processing, Micronaut improves the Java-based development experience by detecting errors at compile time instead of runtime and improves Java-based application start time and memory footprint. Micronaut includes a persistence framework called Micronaut Data that precomputes your SQL queries at compilation time making it a great fit for working with databases like Oracle Autonomous Database, MySQL, etc.
1616

1717
- Micronaut uses GraalVM Native Image to build lightweight Java applications that use less memory and CPUs, and are smaller and faster because of an advanced ahead-of-time compilation technology.
1818

@@ -32,8 +32,8 @@ This sample shows how to use `Oracle GraalVM Enterprise Edition` in `OCI DevOps
3232
## Objectives
3333

3434
- Create an OCI build pipeline.
35-
- Make a build using Oracle GraalVM Enterprise edition.
36-
- Here the focus will be on Build instructions and OCI build pipeline
35+
- Make a build using Oracle GraalVM Enterprise Edition.
36+
- Here the focus will be on the build specification and DevOps build pipeline
3737

3838

3939
## Procedure to use this illustration.
@@ -61,8 +61,6 @@ ALL {resource.type = 'devopsrepository', resource.compartment.id = 'COMPARMENT O
6161
```markdown
6262
Allow dynamic-group "NAME OF THE DynamicGroup" to manage repos in compartment "COMPARTMENT NAME"
6363
Allow dynamic-group "NAME OF THE DynamicGroup" to use ons-topics in compartment "COMPARTMENT NAME"
64-
65-
Allow dynamic-group "NAME OF THE DynamicGroup" to manage repos in compartment "COMPARTMENT NAME"
6664
```
6765

6866
- Switch back to OCI DevOps Project and create an OCI Code repo - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_repo.htm#create_repo
@@ -73,7 +71,7 @@ Allow dynamic-group "NAME OF THE DynamicGroup" to manage repos in compartment "C
7371

7472
![](images/oci_repo_files.png)
7573

76-
- You may use other support version control repos as well (like Github.com,Bitbucket.com, Bitbucket Cloud etc). You may also need to adjust the policies according to connection and setup external connections accordingly - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_connection.htm
74+
- You may use other supported version control repos as well (like Github.com, Bitbucket.com, Bitbucket Cloud, etc). You may also need to adjust the policies according to the connection and setup external connections accordingly - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_connection.htm
7775

7876
- Create a new build pipeline. - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_buildpipeline.htm
7977

@@ -98,14 +96,14 @@ Allow dynamic-group "NAME OF THE DynamicGroup" to manage repos in compartment "C
9896

9997
## Take a closer look at the build instructions below
10098

101-
To install and use GraalVM Enterprise with Micronaut REST in the DevOps build pipeline, the build specification file is as follows:
99+
To install and use GraalVM Enterprise with Micronaut REST in the DevOps build pipeline, the build specification file is as follows:
102100

103101
1. Add the following command to install one or more required GraalVM Enterprise components. For example, this command installs Native Image along with the Java Development Kit (JDK) and other necessary dependencies.
104102

105103
```shell
106104
steps:
107105
- type: Command
108-
name: "Install GraalVM 22.x Native Image for Java17"
106+
name: "Install GraalVM Enterprise 22.x Native Image for Java17"
109107
command: |
110108
yum -y install graalvm22-ee-17-native-image
111109
```
@@ -179,20 +177,22 @@ Here's the complete [build specification](build_spec.yaml) file.
179177
180178
The following instructions will help you to export the `executable app file` to OCI Artifactory and which can then be used in the further stage including deployment pipelines.
181179
182-
Or You can create an OCI Container registry and push the build container image which can be used to deploy to the supported container-based platform (Example OKE).
180+
OR
181+
182+
You can create an OCI Container registry and push the build container image which can be used to deploy to the supported container-based platform (Example OKE).
183183
184184
- Create an OCI artifact registry. https://docs.oracle.com/en-us/iaas/Content/artifacts/home.htm
185185
186186
![](images/oci_artifact_registry.png)
187187
188-
- Create a public OCI Container registry repo - https://docs.oracle.com/en-us/iaas/Content/Registry/home.htm
188+
- Create a public OCI Container registry repo - https://docs.oracle.com/en-us/iaas/Content/Registry/home.htm
189189
190190
![](images/oci_container_repo.png)
191191
192192
193-
- Switch back to `DevOps Project` and create Two `Artifacts`- https://docs.oracle.com/en-us/iaas/Content/devops/using/artifacts.htm
193+
- Switch back to `DevOps Project` and create two `Artifacts`- https://docs.oracle.com/en-us/iaas/Content/devops/using/artifacts.htm
194194
195-
- For the first one select the type as `General artifact`
195+
- For the first one, select the type as `General artifact`
196196
197197
![](images/oci_devops_artifact_1.png)
198198
@@ -203,7 +203,7 @@ Or You can create an OCI Container registry and push the build container image w
203203
204204
- Use option `Set Custom Location` as Artifact location.
205205
- Provide a path and version as `${BUILDRUN_HASH}`, this is to maintain immutable artifacts.
206-
- The variable `BUILDRUN_HASH` is derived during managed build stage and exported as an exportedVariables.You may use any other name ,but ensure to update the file [build_spec.yaml](build_spec.yaml).
206+
- The variable `BUILDRUN_HASH` is derived during managed build stage and exported as an exportedVariables.You may use any other name, but ensure to update the file [build_spec.yaml](build_spec.yaml).
207207
- Select `Yes, substitute placeholders` as an option and click `Add`.
208208
209209
![](images/oci_devops_artifact_3.png)
@@ -228,7 +228,7 @@ Or You can create an OCI Container registry and push the build container image w
228228
229229
- Use name `app_native_executable` result artifact name for artifact reference for `General artifacts` for executable artifact.
230230
- Use name `runtime_image` result artifact name for artifact reference for `Docker image` for container image artifact.
231-
- The name `app_native_executable` and `runtime_image` are a references to the `outputArtifacts` defined under the file [build_spec.yaml](build_spec.yaml).
231+
- The name `app_native_executable` and `runtime_image` are references to the `outputArtifacts` defined under the file [build_spec.yaml](build_spec.yaml).
232232
- Click `Add` and add the stage.
233233
234234
- The build pipeline with two stages would look like the one below.
@@ -249,7 +249,7 @@ Or You can create an OCI Container registry and push the build container image w
249249
![](images/oci_buildstages_done.png)
250250

251251
- Validate the outcome - `executable artifact` or `container image`.
252-
- Switch to `OCI Container registry repo` and you should see a container image, which can be used to deploy onto any supported platform (Example: OKE ) or can refer to the OCI Deployment pipeline too.
252+
- Switch to `OCI Container registry repo` and you should see a container image, which can be used to deploy onto any supported platform (Example: OKE) or can refer to the OCI Deployment pipeline too.
253253

254254
![](images/oci_container_result.png)
255255

@@ -261,17 +261,17 @@ Or You can create an OCI Container registry and push the build container image w
261261

262262
- An additional build instruction file as [build_spec_verbose.yaml](build_spec_verbose.yaml)
263263
can be used for more verbose output with the managed build.
264-
- To do so, switch to `OCI DevOps project` > `OCI Build pipeline ` > Click `3 dots` on the `Managed Build` stage and click on `View details` and then `Edit Stage`.
264+
- To do so, switch to `OCI DevOps project` > `OCI Build pipeline` > Click `3 dots` on the `Managed Build` stage and click on `View details` and then `Edit Stage`.
265265

266266
![](images/oci_buildstage_details.png)
267267

268-
- Change `Build spec file path ` as `build_spec_verbose.yaml` and `Save changes`
268+
- Change `Build spec file path` as `build_spec_verbose.yaml` and `Save changes`
269269

270270
![](images/oci_buildspec_verbose.png)
271271

272272
- Do another manal run for the build pipeline and you will see more verbose build logs.
273273

274-
## Sample Build Logs (Non-verbose mode)
274+
## Sample Build Logs
275275

276276
1. The `yum install` build log statements should be similar to:
277277

@@ -338,7 +338,8 @@ Or You can create an OCI Container registry and push the build container image w
338338
References
339339
==========
340340

341-
- Oracle Cloud Infrastructure DevOps - https://docs.oracle.com/en-us/iaas/Content/devops/using/home.htm
341+
- Using GraalVM Enterprise in DevOps Build Pipelines - https://docs.oracle.com/en-us/iaas/Content/devops/using/graalvm.htm
342+
- Oracle Cloud Infrastructure DevOps - https://docs.oracle.com/en-us/iaas/Content/devops/using/home.htm
342343
- Oracle Graal VM Enterprise - https://www.oracle.com/java/graalvm/
343344

344345
Contributors

0 commit comments

Comments
 (0)