|
1 | | -## Microservice |
2 | | -IBM Cloud Microservice Starter for Java - MicroProfile / Java EE |
3 | | - |
4 | | -[](https://bluemix.net) |
5 | | -[](https://www.ibm.com/developerworks/learn/java/) |
6 | | - |
7 | | -### Table of Contents |
8 | | -* [Summary](#summary) |
9 | | -* [Requirements](#requirements) |
10 | | -* [Configuration](#configuration) |
11 | | -* [Project contents](#project-contents) |
12 | | -* [Run](#run) |
13 | | - |
14 | | -### Summary |
15 | | - |
16 | | -The IBM Cloud Microservice Starter for Java - MicroProfile / Java EE provides a starting point for creating Java microservice applications running on [WebSphere Liberty](https://developer.ibm.com/wasdev/). |
17 | | - |
18 | | - |
19 | | -### Requirements |
20 | | -* [Maven](https://maven.apache.org/install.html) |
21 | | -* Java 8: Any compliant JVM should work. |
22 | | - * [Java 8 JDK from Oracle](http://www.oracle.com/technetwork/java/javase/downloads/index.html) |
23 | | - * [Java 8 JDK from IBM (AIX, Linux, z/OS, IBM i)](http://www.ibm.com/developerworks/java/jdk/), |
24 | | - or [Download a Liberty server package](https://developer.ibm.com/assets/wasdev/#filter/assetTypeFilters=PRODUCT) |
25 | | - that contains the IBM JDK (Windows, Linux) |
26 | | - |
27 | | -### Configuration |
28 | | -The application is configured to provide JAX-RS REST capabilities, JNDI, JSON parsing and Contexts and Dependency Injection (CDI). |
29 | | - |
30 | | -These capabilities are provided through dependencies in the pom.xml file and Liberty features enabled in the server config file found in `src/main/liberty/config/server.xml`. |
31 | | - |
32 | | -### Project contents |
33 | | -The microservice application has a health endpoint which is accessible at `<host>:<port>/gameclient/health`. The context root is set in the `src/main/webapp/WEB-INF/ibm-web-ext.xml` file. The ports are set in the pom.xml file and exposed to the CLI in the cli-config.yml file. |
34 | | - |
35 | | -Credentials are either taken from the VCAP_SERVICES environment variable that IBM Cloud provides or from environment variables passed in by JNDI (see the server config file `src/main/liberty/config/server.xml`). |
36 | | - |
37 | | -### Run |
38 | | - |
39 | | -To build and run the application: |
40 | | -1. `mvn install` |
41 | | -2. `mvn liberty:run-server` |
42 | | - |
43 | | - |
44 | | -To run the application in Docker use the Docker file called `Dockerfile`. If you do not want to install Maven locally you can use `Dockerfile-tools` to build a container with Maven installed. |
45 | | - |
46 | | -### Endpoints |
47 | | - |
48 | | -The application exposes the following endpoints: |
49 | | -* Health endpoint: `<host>:<port>/<contextRoot>/health` |
50 | | - |
51 | | -The context root is set in the `src/main/webapp/WEB-INF/ibm-web-ext.xml` file. The ports are set in the pom.xml file and exposed to the CLI in the cli-config.yml file. |
52 | | - |
53 | | -### Notices |
54 | | - |
55 | | -This project was generated using: |
56 | | -* generator-ibm-java v5.14.1 |
57 | | -* generator-ibm-service-enablement v3.2.1 |
58 | | -* generator-ibm-cloud-enablement v1.7.7 |
59 | | -* generator-ibm-java-liberty v |
| 1 | +Visit the [Rogue Cloud main repository](https://github.com/microclimate-dev2ops/rogue-cloud) for more information about Rogue Cloud. |
0 commit comments