Skip to content

Commit 988e7f2

Browse files
mbwhitejt-nti
authored andcommitted
[FABCJ-293] Remove gradle from image
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
1 parent 7fa88c6 commit 988e7f2

File tree

7 files changed

+81
-294
lines changed

7 files changed

+81
-294
lines changed

COMPATIBILITY.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Support and Compatibility for fabric-chaincode-java
2+
3+
Github is used for code base management, issues should reported in the [FABCJ](https://jira.hyperledger.org/projects/FABCJ/issues/) component in JIRA.
4+
5+
6+
## Summary of Compatibility
7+
8+
This table shows the summary of the compatibility of the Java libraries at versions 1.4 and 2.1, together with the JVM version they require and the Fabric Peer versions they can communicate with.
9+
10+
| | Fabric Peer v1.4 connectivity | Java 8 VM | Fabric Peer v2.1 Connectivity | Java 11 VM |
11+
| ----------------------- | ----------------------------- | --------- | ----------------------------- | ---------- |
12+
| Java libraries **v1.4** | Yes | Yes | Yes | Yes |
13+
| Java libraries **v2.1** | Yes | No | Yes | Yes |
14+
15+
Testing is performed with
16+
- Java v8: Openjdk version 1.8.0_222
17+
- Java v11: Openjdk version 11.04_11
18+
19+
By default a Fabric Peer v1.4 will create a Java 8 VM, and a Fabric Peer v2.1 will create a Java 11 VM. Whilst is the default, the docker image used to host the chaincode and contracts can be altered. Set the environment variable `CORE_CHAINCODE_JAVA_RUNTIME` on the peer to the name of the docker image. For example `CORE_CHAINCODE_JAVA_RUNTIME=example/customJavaRuntime:latest`
20+
21+
The Java Libraries will connect to the peer whilst running; this is referred to as 'Fabric Peer Connectivity' in the table. For example, whilst the Fabric Peer v1.4 will create a Java 8 environment, if a Java 11 environment was configured, the Java Libraries at v2.1.0 still function when connecting to the Fabric Peer v1.4.
22+
23+
## Compatibility
24+
25+
The key elements are : 
26+
27+
- the version of the Fabric Contract Java libraries used
28+
- the version of the JVM used to run the code
29+
- When starting a chaincode container to run a Smart Contract the version of the runtime that is used is determined by these factors:
30+
31+
Fabric v1.4.2, and Fabric v2.1.0 will, by default, start up docker image to host the chaincode and contracts. The version of the docker image used is defined by the version of Fabric in use.
32+
33+
With Fabric v2.1.0, the chaincode container can be configured to be started by other means, and not the Peer. In this case, the environment used is not in the control of Fabric.
34+
35+
The Java libraries are produced are `group: 'org.hyperledger.fabric-chaincode-java', name: 'fabric-chaincode-shim'`
36+
37+
### Supported JVMs
38+
39+
v1.4.x and v2.1.0 Java Libraries are supported running in Java 11 with the x86_64 architecture. Later Java 11 versions are supported but are not tested.
40+
41+
v1.4.x Java Libraries are supported running in Java 8 with the  x86_64 architecture. Later Java 8 versions are supported but are not tested.
42+
43+
Architecture Support: all docker images, JVMs, tools are tested under x86_64 ONLY
44+
45+
### Default Peer Runtime selection
46+
47+
When using Fabric 2.1.0, the default docker image that is used to run the Java chaincode is *openjdk11:jdk-11.04_11-alpine*
48+
49+
With the default docker image used by Fabric 2.1.0. should the packaged Java code contain a Maven or Gradle build script, it will be built using Gradle 5.6.2, or Maven 3.6.2 (if both Gradle and Maven files are present Gradle is used. Gradle build files can be groovy, or kotlin. If the Gradle wrapper is present, this will used in preference to the installed version of Gradle; note that the version of Gradle in the docker image is a copy of the Gradle Wrapper, not the full Gradle install. Therefore if there is limited Internet acccess in your production environment, do not use Gradle). Alternatively it is recommended to package prebuilt jar files, including the contract and all dependencies, in which case no build or Internet access is required when installing Java chaincode.
50+
51+
### Supported Runtime communication with the Peer
52+
 
53+
Subject to a suitable runtime environment, the 1.4.4 and 2.1.0 Java Libraries can used to communicate with a Fabric 2.1.0 or 1.4.4 Peer - with the level of functionality that is implied by the Fabric version in use. 

fabric-chaincode-docker/Dockerfile

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,25 @@ RUN source /root/.sdkman/bin/sdkman-init.sh; mvn install::install-file -Dfile=fa
5959
WORKDIR /root/chaincode-java
6060
RUN rm -rf example-src/*
6161
RUN rm -rf shim-src
62+
63+
RUN gradle wrapper
64+
65+
# Creating final javaenv image which will include all required
66+
# dependencies to build and compile java chaincode
67+
FROM adoptopenjdk/openjdk11:jdk-11.0.4_11-alpine
68+
RUN apk add --no-cache bash
69+
70+
COPY --from=dependencies /root/chaincode-java/gradle /root/chaincode-java/
71+
COPY --from=dependencies /root/chaincode-java/gradlew /root/chaincode-java/gradlew
72+
COPY --from=builder /root/.sdkman/candidates/maven/current /usr/bin/maven
73+
74+
SHELL ["/bin/bash", "-c"]
75+
ENV PATH="/usr/bin/maven/bin:/usr/bin/maven/:/usr/bin/gradle:/usr/bin/gradle/bin:${PATH}"
76+
77+
COPY --from=dependencies /root/chaincode-java /root/chaincode-java
78+
COPY --from=dependencies /root/.m2 /root/.m2
79+
80+
RUN mkdir -p /chaincode/input
81+
RUN mkdir -p /chaincode/output
82+
83+
WORKDIR /root/chaincode-java

fabric-chaincode-docker/build.sh

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ buildGradle() {
88
tar cf - . | (cd ${TMP_DIR}; tar xf -)
99
cd ${TMP_DIR}
1010
echo "Gradle build"
11-
gradle build shadowJar -x test
11+
if [ -f ./gradlew ]; then
12+
chmod +x ./gradlew
13+
./gradlew build shadowJar -x test
14+
else
15+
/root/chaincode-java/gradlew build shadowJar -x test
16+
fi
1217
retval=$?
1318
if [ $retval -ne 0 ]; then
1419
exit $retval

fabric-chaincode-integration-test/src/contracts/fabric-chaincode-example-sacc/gradle/wrapper/gradle-wrapper.properties

Lines changed: 0 additions & 5 deletions
This file was deleted.

fabric-chaincode-integration-test/src/contracts/fabric-chaincode-example-sacc/gradlew

Lines changed: 0 additions & 188 deletions
This file was deleted.

fabric-chaincode-integration-test/src/contracts/fabric-chaincode-example-sacc/gradlew.bat

Lines changed: 0 additions & 100 deletions
This file was deleted.

0 commit comments

Comments
 (0)