In this sample application, you will create a basic Java web application using Spring. This provides a starting point for creating Java microservice applications running on Spring. It contains no default application code, but comes with standard best practices, including a health check and application metric monitoring.
Capabilities are provided through dependencies in the pom.xml
file. The ports are set to the defaults of 8080
for http and 8443
for https and are exposed to the CLI in the cli-config.yml
file. The ports are set in the pom.xml
file and exposed to the CLI in the cli-config.yml
file.
You can deploy this application to IBM Cloud or build it locally by cloning this repo first. Once your app is live, you can access the /health
endpoint to build out your cloud native application.
After you have created a new git repo from this git template, remember to rename the project.
Edit settings.gradle
and change the rootProject.name
from the default name to the name you used to create the template.
Make sure you are logged into the IBM Cloud using the IBM Cloud CLI and have access to you development cluster. If you are using OpenShift make sure you have logged into OpenShift CLI on the command line.
npm i -g @garage-catalyst/ibm-garage-cloud-cli
Use the IBM Garage for Cloud CLI to register the GIT Repo with Jenkins
igc pipeline -n dev
To get started building this application locally, you can either run the application natively or use the IBM Cloud Developer Tools for containerization and easy deployment to IBM Cloud.
- Maven
- Java 11: Any compliant JVM should work.
- Java 11 JDK from Oracle or Download a Liberty server package that contains the IBM JDK (Windows, Linux)
To build and run an application:
./gradlew build
./gradlew bootRun
For more details on how to use this Starter Kit Template please review the IBM Garage for Cloud Developer Tools Developer Guide
- Learn more about augmenting your Java applications on IBM Cloud with the Java Programming Guide.
- Explore other sample applications on IBM Cloud.
This sample application is licensed under the Apache License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 and the Apache License, Version 2.
Finally, the template components can be periodically updated by running the following:
./update-template.sh