Merge pull request #22 from OpenLiberty/staging

Merge staging to prod - Optimize image size (#21)

Author: gkwan-ibm

CONTRIBUTING.md

@@ -2,59 +2,60 @@
 
 Anyone can contribute to the Open Liberty guides and we welcome your contributions!
 
-There are multiple ways to contribute: report bugs, fix bugs, contribute code, improve upon documentation, etc. 
+There are multiple ways to contribute: report bugs, fix bugs, contribute code, improve upon documentation, etc.
 
 ## Raising issues
 
 Please raise any bug reports in this [guide repository](../../issues). For new topics, large updates to existing guides, or general suggestions and ideas, report your issue in the [Open Liberty common guides repository](https://github.com/OpenLiberty/guides-common/issues). Be sure to search the list of open issues to see if your issue has already been raised.
 
 A good bug report makes it easy for everyone to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.
 
-## Contributions 
+## Contributions
 
-Contributing to an Open Liberty guide is simple. All you need to do is create your own branch to include your contribution and open a pull request to the `qa` (quality assurance) branch.
+Contributing to an Open Liberty guide is simple. All you need to do is create your branch to include your contribution and open a pull request to the `staging` (quality assurance) branch.
 
 ### Text or content contributions
 
 If you are contributing text or content changes via a pull request, you need to certify that the originality of the work follows the [Developer Certificate of Origin (DCO)](https://developercertificate.org).
 
 Add a line to the end of the Git commit message to sign your work:
 
-```
+```text
 Signed-off-by: Jane Williams <jane.williams@gmail.com>
 ```
 
 The sign-off is just a line at the end of the commit message that certifies that you wrote it or otherwise have the right to pass it on as an open source patch.
 
-Use your real name when you sign. We can't accept pseudonyms or anonymous contributions. 
+Use your real name when you sign. We can't accept pseudonyms or anonymous contributions.
 
 Many Git UI tools have support for adding the `Signed-off-by` line to the end of your commit message. This line can be automatically added by the `git commit` command by using the `-s` option.
 
-If reviewers agree with your change, your change will be merged to the `master` branch for publishing.
+If reviewers agree with your change, your change will be merged to the `prod` branch for publishing.
 
 ### Code contributions
 
 If you are contributing trivial code changes such as typos, redundant spaces, or minor formatting and spelling errors, follow the instructions under [Text or content contributions](./CONTRIBUTING.md#text-or-content-contributions).
 
-If you are contributing code changes via a pull request for non-trivial changes, you must sign off on the [Individual Contributor License Agreement](https://github.com/OpenLiberty/open-liberty/blob/master/cla/open-liberty-cla-individual.pdf). An example of a non-trivial change could be adding a new
-microservice to the backend application of the guide. 
+If you are contributing code changes via a pull request for non-trivial changes, you must sign off on the [Individual Contributor License Agreement](https://github.com/OpenLiberty/open-liberty/blob/release/cla/open-liberty-cla-individual.pdf). An example of a non-trivial change could be adding a new
+microservice to the backend application of the guide.
 
-If you are contributing changes as part of your job, you may also wish to have your employer sign a [Corporate Contributor License Agreement](https://github.com/OpenLiberty/open-liberty/blob/master/cla/open-liberty-cla-corporate.pdf).
+If you are contributing changes as part of your job, you may also wish to have your employer sign a [Corporate Contributor License Agreement](https://github.com/OpenLiberty/open-liberty/blob/release/cla/open-liberty-cla-corporate.pdf).
 
-Instructions for how to sign and submit these agreements are located at the top of each document. 
+Instructions for how to sign and submit these agreements are located at the top of each document.
 
-After we obtain the signed CLA, you are welcome to open a pull request against the `qa` branch, and the team will be notified for review. We ask you follow these steps through the submission process:
+After we obtain the signed CLA, you are welcome to open a pull request against the `staging` branch, and the team will be notified for review. We ask you to follow these steps through the submission process:
 
-1. Open a pull request against the `qa` branch.
+1. Open a pull request against the `staging` branch.
 2. A "CLA signed" label will be manually added by the team.
-3. The team will be notified and will review your change(s). 
-    - If there are further changes to be made, the team will request changes on the pull request. 
+3. The team will be notified and will review your change(s).
+    - If there are further changes to be made, the team will request changes on the pull request.
     - If the team does not agree with the change, the PR will be closed with an explanation and suggestion for follow-up.
 4. If the team approves, a full Open Liberty site build will be run.
 5. Based on the results of the build:
-    - If further review is needed, we will let you know about a pending review from our team and discuss any necessary improvements that need to be made to your change(s). 
+    - If further review is needed, we will let you know about a pending review from our team and discuss any necessary improvements that need to be made to your change(s).
     - If everything is successful, the team will merge your PR.
 
 ## Questions and concerns
 
 If you have any questions or concerns about the guides or about Open Liberty, you can visit [Gitter for Open Liberty](https://gitter.im/OpenLiberty/) and post your questions in the relevant rooms. You can also join the Open Liberty group on [Groups.io](https://groups.io/g/openliberty) to discuss any issues you have.
+

README.adoc

@@ -217,7 +217,7 @@ You can find all official images on the Open Liberty https://github.com/OpenLibe
 inventory/Containerfile
 [source, Text, linenums, indent=0, role="code_column"]
 ----
-include::finish/inventory/Containerfile[]
+include::finish/inventory/Containerfile-full[]
 ----
 
 The [hotspot=from file=0]`FROM` instruction initializes a new build stage, which indicates the parent image of the built image. If you don't need a parent image, then you can use `FROM scratch`, which makes your image a base image. 
@@ -246,7 +246,7 @@ The `Containerfile` file for the `system` service follows the same instructions
 system/Containerfile
 [source, Text, linenums, indent=0, role="code_column"]
 ----
-include::finish/system/Containerfile[]
+include::finish/system/Containerfile-full[]
 ----
 
 
@@ -494,6 +494,128 @@ You can externalize the configuration of more than just the port numbers.
 To learn more about Open Liberty server configuration, check out the
 https://openliberty.io/docs/latest/reference/config/server-configuration-overview.html[Server Configuration Overview^] docs. 
 
+== Optimizing the image size
+
+As mentioned previously, the parent image that is used in each `Containerfile` contains the `full` tag, which includes all of the Liberty features. This parent image with the `full` tag is recommended for development, but while deploying to production it is recommended to use a parent image with the `kernel-slim` tag. The `kernel-slim` tag provides a bare minimum server with the ability to add the features required by the application.
+
+[role="code_command hotspot file=0", subs="quotes"]
+----
+#Replace the `Containerfile` for the inventory service.#
+`inventory/Containerfile`
+----
+
+inventory/Containerfile
+[source, Text, linenums, indent=0, role="code_column"]
+----
+include::finish/inventory/Containerfile[]
+----
+
+Replace the parent image with [hotspot=kernel-slim file=0]`icr.io/appcafe/open-liberty:kernel-slim-java11-openj9-ubi` at the top of your `Containerfile`. This image contains the `kernel-slim` tag that is recommended when deploying to production.
+
+Place [hotspot=features file=0]`RUN features.sh` command after the COPY command that the configuration file is copied to the `/config/` destination directory. The `features.sh` script adds the Liberty features that your application is required to operate.
+
+Ensure that you repeat these instructions for the `system` service.
+
+[role="code_command hotspot file=1", subs="quotes"]
+----
+#Replace the `Containerfile` for the system service.#
+`system/Containerfile`
+----
+
+system/Containerfile
+[source, Text, linenums, indent=0, role="code_column"]
+----
+include::finish/system/Containerfile[]
+----
+
+Continue by running the following commands to stop and remove your current containers that are using the `full` parent image:
+
+[role='command']
+```
+podman stop inventory system
+podman rm inventory system
+```
+
+Next, build your new images with the `kernel-slim` parent image:
+
+[role='command']
+```
+podman build -t system:1.0-SNAPSHOT system/.
+podman build -t inventory:1.0-SNAPSHOT inventory/.
+```
+
+Verify that the images have been built by executing the following command to list all the local images:
+
+[role='command']
+```
+podman images
+```
+
+Notice that the images for the `inventory` and `system` services now have a reduced image size.
+----
+REPOSITORY            TAG            IMAGE ID       CREATED         SIZE
+localhost/inventory   1.0-SNAPSHOT   eee0d13f0e80   3 minutes ago   674 MB
+localhost/system      1.0-SNAPSHOT   5b8f87d6f0d5   4 minutes ago   726 MB
+----
+
+After confirming that the images have been built, run the following commands to start the containers:
+
+[role='command']
+```
+podman run -d --name system -p 9080:9080 system:1.0-SNAPSHOT
+podman run -d --name inventory -p 9081:9081 inventory:1.0-SNAPSHOT
+```
+
+Once your containers are running, run the following command to see the list of the required features installed by `features.sh`:
+[role='command']
+```
+podman exec -it inventory /opt/ol/wlp/bin/productInfo featureInfo
+```
+
+Your list of Liberty features should be similar to the following:
+----
+jndi-1.0
+servlet-5.0
+cdi-3.0
+concurrent-2.0
+jsonb-2.0
+jsonp-2.0
+mpConfig-3.0
+restfulWS-3.0
+restfulWSClient-3.0
+----
+
+// static guide instructions:
+ifndef::cloud-hosted[]
+To ensure that your containers are working properly, try accessing the `system` service to show the system properties of the running JVM.
+See http://localhost:9080/system/properties[http://localhost:9080/system/properties]
+
+Next, replace `[system-ip-address]` with the IP address that you obtained earlier and add your localhost system properties to the `inventory` service by visiting:
+`\http://localhost:9081/inventory/systems/pass:c[[system-ip-address]]`
+
+Then, verify the addition of your localhost system properties to your `inventory` service. 
+See http://localhost:9081/inventory/systems[http://localhost:9081/inventory/systems]
+endif::[]
+
+// cloud-hosted guide instructions:
+ifdef::cloud-hosted[]
+The **system** service which shows the system properties of the running JVM, is now available to be accessed at **http://localhost:9080/system/properties**. Run the following curl command:
+```bash
+curl -s http://localhost:9080/system/properties | jq
+```
+
+Next, you can add your local system properties at the **http://localhost:9081/inventory/systems/[system-ip-address]** URL by replacing **[system-ip-address]** with the IP address that you obtained in the previous section. Run the following commands:
+```bash
+SYSTEM_IP=`podmandocker inspect -f "{{.NetworkSettings.IPAddress }}" system`
+curl -s http://localhost:9081/inventory/systems/{$SYSTEM_IP} | jq
+```
+
+Then, verify the addition of your localhost system properties to the **inventory** service at **http://localhost:9081/inventory/systems**. Run the following curl command:
+```bash
+curl -s http://localhost:9081/inventory/systems | jq
+```
+endif::[]
+
 == Testing the microservices
 
 You can test your microservices manually by hitting the endpoints or with automated tests that check your running containers.
@@ -538,7 +660,7 @@ Run the Maven `package` goal to compile the test classes. Run the Maven `failsaf
 [role='command']
 ```
 mvn package
-mvn failsafe:integration-test -Dsystem.ip=[system-ip-address] -Dinventory.http.port=9091 -Dsystem.http.port=9080
+mvn failsafe:integration-test -Dsystem.ip=[system-ip-address] -Dinventory.http.port=9081 -Dsystem.http.port=9080
 ```
 endif::[]
 
@@ -549,7 +671,7 @@ Run the Maven **package** goal to compile the test classes. Run the Maven **fail
 ```
 SYSTEM_IP=`podman inspect -f "{{.NetworkSettings.IPAddress }}" system`
 mvn package
-mvn failsafe:integration-test -Dsystem.ip="$SYSTEM_IP" -Dinventory.http.port=9091 -Dsystem.http.port=9080
+mvn failsafe:integration-test -Dsystem.ip="$SYSTEM_IP" -Dinventory.http.port=9081 -Dsystem.http.port=9080
 ```
 {: codeblock}
 endif::[]

finish/inventory/Containerfile

@@ -1,6 +1,6 @@
-# tag::from[]
-FROM icr.io/appcafe/open-liberty:full-java11-openj9-ubi
-# end::from[]
+# tag::kernel-slim[]
+FROM icr.io/appcafe/open-liberty:kernel-slim-java11-openj9-ubi
+# end::kernel-slim[]
 
 ARG VERSION=1.0
 ARG REVISION=SNAPSHOT
@@ -32,6 +32,10 @@ COPY --chown=1001:0 \
     # end::config[]
 # end::copy-config[]
 
+# tag::features[]
+RUN features.sh
+# end::features[]
+
 # tag::copy-war[]
 # tag::war-userID[]
 COPY --chown=1001:0 \

finish/inventory/Containerfile-full

@@ -0,0 +1,49 @@
+# tag::from[]
+FROM icr.io/appcafe/open-liberty:full-java11-openj9-ubi
+# end::from[]
+
+ARG VERSION=1.0
+ARG REVISION=SNAPSHOT
+
+# tag::label[]
+LABEL \
+  org.opencontainers.image.authors="Your Name" \
+  org.opencontainers.image.vendor="Open Liberty" \
+  org.opencontainers.image.url="local" \
+  org.opencontainers.image.source="https://github.com/OpenLiberty/guide-containerize" \
+  org.opencontainers.image.version="$VERSION" \
+  org.opencontainers.image.revision="$REVISION" \
+  vendor="Open Liberty" \
+  name="inventory" \
+  version="$VERSION-$REVISION" \
+  summary="The inventory microservice from the Containerizing microservices guide" \
+  description="This image contains the inventory microservice running with the Open Liberty runtime."
+# end::label[]
+
+# tag::copy-config[]
+# tag::config-userID[]
+COPY --chown=1001:0 \
+# end::config-userID[]
+    # tag::inventory-config[]
+    src/main/liberty/config \
+    # end::inventory-config[]
+    # tag::config[]
+    /config/
+    # end::config[]
+# end::copy-config[]
+
+# tag::copy-war[]
+# tag::war-userID[]
+COPY --chown=1001:0 \
+# end::war-userID[]
+    # tag::inventory-war[]
+    target/inventory.war \
+    # end::inventory-war[]
+    # tag::config-apps[]
+    /config/apps
+    # end::config-apps[]
+# end::copy-war[]
+
+# tag::configure-sh[]
+RUN configure.sh
+# end::configure-sh[]

finish/inventory/pom.xml

@@ -29,13 +29,13 @@
         <dependency>
             <groupId>jakarta.platform</groupId>
             <artifactId>jakarta.jakartaee-api</artifactId>
-            <version>8.0.0</version>
+            <version>9.1.0</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.eclipse.microprofile</groupId>
             <artifactId>microprofile</artifactId>
-            <version>4.1</version>
+            <version>5.0</version>
             <type>pom</type>
             <scope>provided</scope>
         </dependency>
@@ -49,25 +49,25 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <version>5.7.1</version>
+            <version>5.8.2</version>
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.apache.cxf</groupId>
-            <artifactId>cxf-rt-rs-client</artifactId>
-            <version>3.4.3</version>
+            <groupId>org.jboss.resteasy</groupId>
+            <artifactId>resteasy-client</artifactId>
+            <version>6.0.0.Final</version>
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.apache.cxf</groupId>
-            <artifactId>cxf-rt-rs-extension-providers</artifactId>
-            <version>3.4.3</version>
+            <groupId>org.jboss.resteasy</groupId>
+            <artifactId>resteasy-json-binding-provider</artifactId>
+            <version>6.0.0.Final</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.glassfish</groupId>
-            <artifactId>javax.json</artifactId>
-            <version>1.1.4</version>
+            <artifactId>jakarta.json</artifactId>
+            <version>2.0.1</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -106,4 +106,4 @@
             </plugin>
         </plugins>
     </build>
-</project>
+</project>

finish/inventory/src/main/java/io/openliberty/guides/inventory/InventoryApplication.java

@@ -1,6 +1,6 @@
 // tag::copyright[]
 /*******************************************************************************
- * Copyright (c) 2017 IBM Corporation and others.
+ * Copyright (c) 2017, 2022 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -9,12 +9,12 @@
  * Contributors:
  *     IBM Corporation - Initial implementation
  *******************************************************************************/
- // end::copyright[]
+// end::copyright[]
 package io.openliberty.guides.inventory;
 
 // JAX-RS
-import javax.ws.rs.ApplicationPath;
-import javax.ws.rs.core.Application;
+import jakarta.ws.rs.ApplicationPath;
+import jakarta.ws.rs.core.Application;
 
 @ApplicationPath("inventory")
 public class InventoryApplication extends Application {