Merge pull request #196 from PasanT9/4.2.0.1-release

Add support for APIM 4.2.0

README.md

@@ -38,9 +38,9 @@ This repository contains the Ansible scripts for installing and configuring WSO2
 │   └── Pattern_5.md
 ├── files
 │   ├── lib
-│   │   ├── amazon-corretto-11.0.14.1-linux-x64.tar.gz
+│   │   ├── amazon-corretto-17.0.6.10.1-linux-x64.tar.gz
 │   └── packs
-│   │   ├── wso2am-4.1.0.zip
+│   │   ├── wso2am-4.2.0.zip
 │   ├── system
 │   │   └── etc
 │   │       ├── security
@@ -78,11 +78,11 @@ Packs could be either copied to a local directory, or downloaded from a remote l
 
 Copy the following files to `files/packs` directory.
 
-1. [WSO2 API Manager 4.1.0 package (.zip)](https://wso2.com/api-management/install/)
+1. [WSO2 API Manager 4.2.0 package (.zip)](https://wso2.com/api-management/install/)
 
 Copy the following files to `files/lib` directory.
 
-1. [Amazon Corretto for Linux x64 JDK 11 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)
+1. [Amazon Corretto for Linux x64 JDK 17 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)
 
 Copy the miscellaneous files to `files/misc` directory. To enable file copying,  uncomment the `misc_file_list` in the yaml files under `group_vars` and add the miscellaneous files to the list.
 
@@ -173,6 +173,6 @@ Refer the below documentation on configuring Load-Balancers for your deoloyment.
 
 The master branch of this repository contains the latest product version with the latest Ansible version. The Ansible resources for previous Ansible versions can be found in the branches. The following is an example.
 
-#### Ansible resources for API Manager 4.0.0
+#### Ansible resources for API Manager 4.1.0
 
-Branch name: 4.0.x
+Branch name: 4.1.x

dev/group_vars/apim.yml

@@ -17,7 +17,7 @@
 wso2_group: wso2 # OS group to be created
 wso2_user: wso2carbon # OS user for WSO2 services
 product_name: wso2am
-product_version: 4.1.0
+product_version: 4.2.0
 target: /mnt # Product installation directory
 product_package_location: files
 backup_dir: /tmp # Artifact backup directory in the instance
@@ -70,12 +70,12 @@ performance_tuning_file_list:
 # Set the location the product packages should reside in (eg: "local" in the /files directory, "remote" in a remote location)
 pack_location: local
 #pack_location: remote
-#remote_jdk: "<URL_TO_JDK_FILE>" Ex:- "https://corretto.aws/downloads/latest/amazon-corretto-11-x64-linux-jdk.tar.gz"
-#remote_pack: "<URL_TO_APIM_PACK>" Ex:- "https://github.com/wso2/product-apim/releases/download/v4.1.0/wso2am-4.1.0.zip"
+#remote_jdk: "<URL_TO_JDK_FILE>"
+#remote_pack: "<URL_TO_APIM_PACK>"
 
 # JDK Distributions
 setup_java_enabled: true #If this is set to false java_home variable below needs to be specified.
-jdk_name: amazon-corretto-11.0.14.1-linux-x64 # Update this as per jdk version you use
+jdk_name: amazon-corretto-17.0.6.10.1-linux-x64 # Update this as per jdk version you use
 java_dir: /opt
 java_symlink: "{{ java_dir }}/java"
 java_home: "{{ java_dir }}/{{ jdk_name }}"

dev/group_vars/micro-integrator.yml

@@ -17,7 +17,7 @@
 wso2_group: wso2 # OS group to be created
 wso2_user: wso2carbon # OS user for WSO2 services
 product_name: wso2mi
-product_version: 4.1.0
+product_version: 4.2.0
 target: /mnt # Product installation directory
 product_package_location: files
 backup_dir: /tmp # Artifact backup directory in the instance
@@ -75,12 +75,12 @@ performance_tuning_file_list:
 # Set the location the product packages should reside in (eg: "local" in the /files directory, "remote" in a remote location)
 pack_location: local
 #pack_location: remote
-#remote_jdk: "<URL_TO_JDK_FILE>" Ex:- "https://corretto.aws/downloads/latest/amazon-corretto-11-x64-linux-jdk.tar.gz"
-#remote_pack: "<URL_TO_APIM_PACK>" Ex:- "https://github.com/wso2/product-apim/releases/download/v4.1.0/wso2am-4.1.0.zip"
+#remote_jdk: "<URL_TO_JDK_FILE>"
+#remote_pack: "<URL_TO_APIM_PACK>"
 
 # JDK Distributions
 setup_java_enabled: true #If this is set to false java_home variable below needs to be specified.
-jdk_name: amazon-corretto-11.0.14.1-linux-x64 # Update this as per jdk version you use
+jdk_name: amazon-corretto-17.0.6.10.1-linux-x64 # Update this as per jdk version you use
 java_dir: /opt
 java_symlink: "{{ java_dir }}/java"
 java_home: "{{ java_dir }}/{{ jdk_name }}"

docs/Pattern_1.md

@@ -9,7 +9,7 @@ The Ansible scripts are capable of installing java from a given JDK installer fr
 
 Copy the following files to `files/lib` directory.
 
-1. [Amazon Corretto JDK 11 for Linux x64 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)
+1. [Amazon Corretto JDK 17 for Linux x64 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)
 
 ## Adding miscellaneous files
 If additional files needs to be added to the VMs, copy the miscellaneous files to `files/misc` directory. To enable file copying,  uncomment the `misc_file_list` in the yaml files under `group_vars` and add the miscellaneous files to the list.
@@ -18,8 +18,8 @@ If additional files needs to be added to the VMs, copy the miscellaneous files t
 
 Copy the following files to `files/packs` directory.
 
-1. [WSO2 API Manager 4.1.0 package (.zip)](https://wso2.com/api-management/install/)
-2. [WSO2 Micro Integrator 4.1.0 package (.zip)](https://github.com/wso2/micro-integrator/releases/tag/v4.1.0)
+1. [WSO2 API Manager 4.2.0 package (.zip)](https://wso2.com/api-management/)
+2. [WSO2 Micro Integrator 4.2.0 package (.zip)](https://wso2.com/micro-integrator)
 
 ## Database configurations
 

docs/Pattern_2.md

@@ -9,7 +9,7 @@ The Ansible scripts are capable of installing java from a given JDK installer fr
 
 Copy the following files to `files/lib` directory.
 
-1. [Amazon Corretto JDK 11 for Linux x64 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)
+1. [Amazon Corretto JDK 17 for Linux x64 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)
 
 ## Adding miscellaneous files
 If additional files needs to be added to the VMs, copy the miscellaneous files to `files/misc` directory. To enable file copying,  uncomment the `misc_file_list` in the yaml files under `group_vars` and add the miscellaneous files to the list.
@@ -18,8 +18,8 @@ If additional files needs to be added to the VMs, copy the miscellaneous files t
 
 Copy the following files to `files/packs` directory.
 
-1. [WSO2 API Manager 4.1.0 package (.zip)](https://wso2.com/api-management/install/)
-2. [WSO2 Micro Integrator 4.1.0 package (.zip)](https://github.com/wso2/micro-integrator/releases/tag/v4.1.0)
+1. [WSO2 API Manager 4.2.0 package (.zip)](https://wso2.com/api-management/)
+2. [WSO2 Micro Integrator 4.2.0 package (.zip)](https://wso2.com/micro-integrator)
 
 ## Database configurations
 

docs/Pattern_3.md

@@ -9,7 +9,7 @@ The Ansible scripts are capable of installing java from a given JDK installer fr
 
 Copy the following files to `files/lib` directory.
 
-1. [Amazon Corretto JDK 11 for Linux x64 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)
+1. [Amazon Corretto JDK 17 for Linux x64 (.tar.gz)](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)
 
 ## Adding miscellaneous files
 If additional files needs to be added to the VMs, copy the miscellaneous files to `files/misc` directory. To enable file copying,  uncomment the `misc_file_list` in the yaml files under `group_vars` and add the miscellaneous files to the list.
@@ -18,8 +18,8 @@ If additional files needs to be added to the VMs, copy the miscellaneous files t
 
 Copy the following files to `files/packs` directory. (Packs must be copied as per the required components). You need to add the ZIP Archive of the WSO2 distributions.
 
-1. [WSO2 API Manager 4.1.0 package (.zip)](https://wso2.com/api-management/install/)
-2. [WSO2 Micro Integrator 4.1.0 package (.zip)](https://github.com/wso2/micro-integrator/releases/tag/v4.1.0)
+1. [WSO2 API Manager 4.2.0 package (.zip)](https://wso2.com/api-management/install/)
+2. [WSO2 Micro Integrator 4.2.0 package (.zip)](https://wso2.com/micro-integrator)
 
 ## Database configurations
 

roles/apim-control-plane/templates/carbon-home/bin/api-manager.sh.j2

@@ -237,9 +237,9 @@ fi
 # ---------- Handle the SSL Issue with proper JDK version --------------------
 java_version=$("$JAVACMD" -version 2>&1 | awk -F '"' '/version/ {print $2}')
 java_version_formatted=$(echo "$java_version" | awk -F. '{printf("%02d%02d",$1,$2);}')
-if [ $java_version_formatted -lt 0107 ] || [ $java_version_formatted -gt 1100 ]; then
+if [ $java_version_formatted -lt 1100 ] || [ $java_version_formatted -gt 1700 ]; then
    echo " Starting WSO2 Carbon (in unsupported JDK)"
-   echo " [ERROR] CARBON is supported only on JDK 1.7, 1.8, 9, 10 and 11"
+   echo " [ERROR] CARBON is supported only between JDK 11 and JDK 17"
 fi
 
 CARBON_XBOOTCLASSPATH=""
@@ -309,11 +309,10 @@ echo "Using Java memory options: $JVM_MEM_OPTS"
 #To monitor a Carbon server in remote JMX mode on linux host machines, set the below system property.
 #   -Djava.rmi.server.hostname="your.IP.goes.here"
 
-JAVA_VER_BASED_OPTS=""
+JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED"
 
-
-if [ $java_version_formatted -ge 1100 ]; then
-    JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED"
+if [ $java_version_formatted -ge 1700 ]; then
+    JAVA_VER_BASED_OPTS="$JAVA_VER_BASED_OPTS --add-opens=java.naming/com.sun.jndi.ldap=ALL-UNNAMED"
 fi
 
 while [ "$status" = "$START_EXIT_STATUS" ]
@@ -355,6 +354,9 @@ do
     -DenableCorrelationLogs=false \
     -Dcarbon.new.config.dir.path="$CARBON_HOME/repository/resources/conf" \
     -Djavax.xml.xpath.XPathFactory:http://java.sun.com/jaxp/xpath/dom=net.sf.saxon.xpath.XPathFactoryImpl \
+    -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector \
+    -Dorg.ops4j.pax.logging.logReaderEnabled=false \
+    -Dorg.ops4j.pax.logging.eventAdminEnabled=false \
     org.wso2.carbon.bootstrap.Bootstrap $*
     status=$?
 done

roles/apim-gateway/templates/carbon-home/bin/api-manager.sh.j2

@@ -237,9 +237,9 @@ fi
 # ---------- Handle the SSL Issue with proper JDK version --------------------
 java_version=$("$JAVACMD" -version 2>&1 | awk -F '"' '/version/ {print $2}')
 java_version_formatted=$(echo "$java_version" | awk -F. '{printf("%02d%02d",$1,$2);}')
-if [ $java_version_formatted -lt 0107 ] || [ $java_version_formatted -gt 1100 ]; then
+if [ $java_version_formatted -lt 1100 ] || [ $java_version_formatted -gt 1700 ]; then
    echo " Starting WSO2 Carbon (in unsupported JDK)"
-   echo " [ERROR] CARBON is supported only on JDK 1.7, 1.8, 9, 10 and 11"
+   echo " [ERROR] CARBON is supported only between JDK 11 and JDK 17"
 fi
 
 CARBON_XBOOTCLASSPATH=""
@@ -309,11 +309,10 @@ echo "Using Java memory options: $JVM_MEM_OPTS"
 #To monitor a Carbon server in remote JMX mode on linux host machines, set the below system property.
 #   -Djava.rmi.server.hostname="your.IP.goes.here"
 
-JAVA_VER_BASED_OPTS=""
+JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED"
 
-
-if [ $java_version_formatted -ge 1100 ]; then
-    JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED"
+if [ $java_version_formatted -ge 1700 ]; then
+    JAVA_VER_BASED_OPTS="$JAVA_VER_BASED_OPTS --add-opens=java.naming/com.sun.jndi.ldap=ALL-UNNAMED"
 fi
 
 while [ "$status" = "$START_EXIT_STATUS" ]
@@ -355,6 +354,9 @@ do
     -DenableCorrelationLogs=false \
     -Dcarbon.new.config.dir.path="$CARBON_HOME/repository/resources/conf" \
     -Djavax.xml.xpath.XPathFactory:http://java.sun.com/jaxp/xpath/dom=net.sf.saxon.xpath.XPathFactoryImpl \
+    -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector \
+    -Dorg.ops4j.pax.logging.logReaderEnabled=false \
+    -Dorg.ops4j.pax.logging.eventAdminEnabled=false \
     org.wso2.carbon.bootstrap.Bootstrap $*
     status=$?
 done

roles/apim-gateway/templates/carbon-home/repository/conf/deployment.toml.j2

@@ -1,5 +1,7 @@
 [server]
-#hostname = "gw.wso2.com"
+hostname = "{{ hostname }}"
+offset="{{ ports_offset }}"
+base_path = "${carbon.protocol}://${carbon.host}:${carbon.management.port}"
 server_role = "gateway-worker"
 
 [user_store]

roles/apim-tm/templates/carbon-home/bin/api-manager.sh.j2

@@ -237,9 +237,9 @@ fi
 # ---------- Handle the SSL Issue with proper JDK version --------------------
 java_version=$("$JAVACMD" -version 2>&1 | awk -F '"' '/version/ {print $2}')
 java_version_formatted=$(echo "$java_version" | awk -F. '{printf("%02d%02d",$1,$2);}')
-if [ $java_version_formatted -lt 0107 ] || [ $java_version_formatted -gt 1100 ]; then
+if [ $java_version_formatted -lt 1100 ] || [ $java_version_formatted -gt 1700 ]; then
    echo " Starting WSO2 Carbon (in unsupported JDK)"
-   echo " [ERROR] CARBON is supported only on JDK 1.7, 1.8, 9, 10 and 11"
+   echo " [ERROR] CARBON is supported only between JDK 11 and JDK 17"
 fi
 
 CARBON_XBOOTCLASSPATH=""
@@ -262,10 +262,10 @@ do
     fi
 done
 for t in "$CARBON_HOME"/lib/*.jar
-	do
-	    CARBON_CLASSPATH="$CARBON_CLASSPATH":$t
-	done
-	for t in "$CARBON_HOME"/lib/endorsed/*.jar
+do
+    CARBON_CLASSPATH="$CARBON_CLASSPATH":$t
+done
+for t in "$CARBON_HOME"/lib/endorsed/*.jar
 do
     CARBON_CLASSPATH="$CARBON_CLASSPATH":$t
 done
@@ -309,11 +309,10 @@ echo "Using Java memory options: $JVM_MEM_OPTS"
 #To monitor a Carbon server in remote JMX mode on linux host machines, set the below system property.
 #   -Djava.rmi.server.hostname="your.IP.goes.here"
 
-JAVA_VER_BASED_OPTS=""
-
+JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED"
 
-if [ $java_version_formatted -ge 1100 ]; then
-    JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED"
+if [ $java_version_formatted -ge 1700 ]; then
+    JAVA_VER_BASED_OPTS="$JAVA_VER_BASED_OPTS --add-opens=java.naming/com.sun.jndi.ldap=ALL-UNNAMED"
 fi
 
 while [ "$status" = "$START_EXIT_STATUS" ]
@@ -355,6 +354,9 @@ do
     -DenableCorrelationLogs=false \
     -Dcarbon.new.config.dir.path="$CARBON_HOME/repository/resources/conf" \
     -Djavax.xml.xpath.XPathFactory:http://java.sun.com/jaxp/xpath/dom=net.sf.saxon.xpath.XPathFactoryImpl \
+    -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector \
+    -Dorg.ops4j.pax.logging.logReaderEnabled=false \
+    -Dorg.ops4j.pax.logging.eventAdminEnabled=false \
     org.wso2.carbon.bootstrap.Bootstrap $*
     status=$?
 done

roles/apim/templates/carbon-home/bin/api-manager.sh.j2

@@ -237,9 +237,9 @@ fi
 # ---------- Handle the SSL Issue with proper JDK version --------------------
 java_version=$("$JAVACMD" -version 2>&1 | awk -F '"' '/version/ {print $2}')
 java_version_formatted=$(echo "$java_version" | awk -F. '{printf("%02d%02d",$1,$2);}')
-if [ $java_version_formatted -lt 0107 ] || [ $java_version_formatted -gt 1100 ]; then
+if [ $java_version_formatted -lt 1100 ] || [ $java_version_formatted -gt 1700 ]; then
    echo " Starting WSO2 Carbon (in unsupported JDK)"
-   echo " [ERROR] CARBON is supported only on JDK 1.7, 1.8, 9, 10 and 11"
+   echo " [ERROR] CARBON is supported only between JDK 11 and JDK 17"
 fi
 
 CARBON_XBOOTCLASSPATH=""
@@ -309,11 +309,10 @@ echo "Using Java memory options: $JVM_MEM_OPTS"
 #To monitor a Carbon server in remote JMX mode on linux host machines, set the below system property.
 #   -Djava.rmi.server.hostname="your.IP.goes.here"
 
-JAVA_VER_BASED_OPTS=""
+JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED"
 
-
-if [ $java_version_formatted -ge 1100 ]; then
-    JAVA_VER_BASED_OPTS="--add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED"
+if [ $java_version_formatted -ge 1700 ]; then
+    JAVA_VER_BASED_OPTS="$JAVA_VER_BASED_OPTS --add-opens=java.naming/com.sun.jndi.ldap=ALL-UNNAMED"
 fi
 
 while [ "$status" = "$START_EXIT_STATUS" ]
@@ -355,6 +354,9 @@ do
     -DenableCorrelationLogs=false \
     -Dcarbon.new.config.dir.path="$CARBON_HOME/repository/resources/conf" \
     -Djavax.xml.xpath.XPathFactory:http://java.sun.com/jaxp/xpath/dom=net.sf.saxon.xpath.XPathFactoryImpl \
+    -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector \
+    -Dorg.ops4j.pax.logging.logReaderEnabled=false \
+    -Dorg.ops4j.pax.logging.eventAdminEnabled=false \
     org.wso2.carbon.bootstrap.Bootstrap $*
     status=$?
 done

roles/apim/templates/carbon-home/repository/conf/deployment.toml.j2

@@ -109,6 +109,7 @@ enable = {{ analytics_apim_enabled | bool | lower }}
 auth_token = "{{ analytics_apim_auth_token }}"
 
 [apim.key_manager]
+enable_apikey_subscription_validation = true
 service_url = "{{ key_manager_server_url }}"
 username = "$ref{super_admin.username}"
 password = "$ref{super_admin.password}"

roles/micro-integrator/templates/carbon-home/bin/micro-integrator.sh.j2

@@ -197,7 +197,7 @@ java_version=$("$JAVACMD" -version 2>&1 | awk -F '"' '/version/ {print $2}')
 java_version_formatted=$(echo "$java_version" | awk -F. '{printf("%02d%02d",$1,$2);}')
 if [ $java_version_formatted -lt 0107 ] || [ $java_version_formatted -gt 1100 ]; then
    echo " Starting WSO2 MI (in unsupported JDK)"
-   echo " [ERROR] MI is supported only on JDK 1.8, 9, 10 and 11"
+   echo " [ERROR] MI is supported only on JDK 11 and 17"
 fi
 
 CARBON_XBOOTCLASSPATH=""

scripts/update.sh

@@ -22,7 +22,7 @@
 set -e
 
 # Build artifacts and versions
-: ${version:="4.0.0"}
+: ${version:="4.2.0"}
 : ${packs_dir:=$(pwd)/../files/packs}
 
 usage() { echo "Usage: $0 -p <profile_name>" 1>&2; exit 1; }

scripts/update_README.md

@@ -33,8 +33,8 @@ In the below sample, it uses the remote location as `/mnt/`.
 Please find the sample configurations for `<Ansible_Home>/group_vars/apim.yml`.
 ```java
 pack_location: remote
-remote_jdk: "/mnt/amazon-corretto-11.0.14.1-linux-x64.tar.gz"
-remote_pack: "/mnt/wso2am-4.1.0.zip"
+remote_jdk: "/mnt/amazon-corretto-17.0.6.10.1-linux-x64.tar.gz"
+remote_pack: "/mnt/wso2am-4.2.0.zip"
 ```
 
 NOTES:

site.yml

@@ -39,15 +39,15 @@
 #
 # - name: Apply API Management <profile> configuration to an apim node
 #   hosts:
-#     - apim_1
+#     - apim-<profile>_1
 #   roles:
 #     - apim-<profile>
 #
 # An example is given below. This will deploy API Manager developer portal profile in apim_1 node.
 #
 # - name: Apply API Management developer portal configuration to an apim node
 #   hosts:
-#     - apim_1
+#     - apim-control-plane_1
 #   roles:
 #     - apim-control-plane
 #