[
https://issues.apache.org/jira/browse/GEODE-10525?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jinwoo Hwang updated GEODE-10525:
---------------------------------
Description:
h2. Summary
Update the Apache Geode installation documentation to reflect the current
supported Java version requirements.
h2. Description
The installation guide needs to be updated to ensure users are aware of the
correct Java version requirements for running Apache Geode. This includes
updating:
* Minimum Java version required
* Recommended Java versions
* Deprecated Java versions (if any)
* Any version-specific configuration notes
h2. Acceptance Criteria
* Installation guide reflects current Java version requirements
* All references to Java versions are consistent across documentation
* Examples and code snippets use supported Java versions
* Build instructions specify correct Java version
h2. Documentation Sections to Update
* Getting Started / Prerequisites
* Installation Guide
* Building from Source
* System Requirements
h2. Testing
* Verify documentation builds successfully
* Ensure all links and references are valid
* Review for consistency with actual codebase requirements
was:
h2. Summary
Update Apache Geode documentation to reflect Jakarta EE 10 compatibility and
Java 17 requirements for version 2.0
h2. Description
This task updates the Apache Geode documentation to reflect the migration from
Java EE to Jakarta EE 10 and the upgrade from Java 8 to Java 17 as the minimum
supported version.
h3. Background
Apache Geode 2.0 introduces breaking changes due to:
# Migration from Java EE ({{{}javax) to Jakarta EE 10 {}}}
# Minimum Java version upgrade from Java 8 to Java 17
# Updated dependency versions to support Jakarta EE 10
h3. Scope
All documentation files in the {{geode-docs/}} directory that reference:
* Java version formatting
* JAR file versions
* HTTP session management module setup
* WebLogic integration configuration
h2. Changes
h3. 1. Java Version Format Update
{*}Problem{*}: Documentation used Java 8 version format ({{{}1.8.0_121{}}})
which is incompatible with Java 17 versioning ({{{}17.0.16{}}}).
h4. Template Variables
{*}File{*}: {{geode-book/config.yml}}
{code:yaml}
min_java_version: '8'
min_java_update: '121'
{code}
h4. Files (20+ occurrences)
# {{configuring/cluster_config/persisting_configurations.html.md.erb}} (7
occurrences)
# {{getting_started/15_minute_quickstart_gfsh.html.md.erb}} (2 occurrences)
# {{getting_started/installation/install_standalone.html.md.erb}} (4
occurrences)
# {{managing/management/jmx_manager_operations.html.md.erb}} (1 occurrence)
# {{configuring/running/running_the_locator.html.md.erb}} (1 occurrence)
# {{configuring/running/running_the_cacheserver.html.md.erb}} (1 occurrence)
# {{tools_modules/http_session_mgmt/tc_additional_info.html.md.erb}} (1
occurrence)
# {{tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb}} (1
occurrence)
# {{tools_modules/gfsh/tour_of_gfsh.html.md.erb}} (3 occurrences)
#
{{tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb}}
(1 occurrence)
{*}Examples of changes{*}:
* Java Version output in gfsh: {{Java Version: 17.0.16}}
* JAVA_HOME paths: {{/usr/java/jdk-17.0.16}}
* JVM Version in Tomcat: {{17.0.16}}
----
h3. 2. JAR Version Updates
{*}Problem{*}: Documentation referenced Geode 1.0.0 JAR files which are
outdated for version 2.0.
h4. Files (4 occurrences)
# {{getting_started/15_minute_quickstart_gfsh.html.md.erb}}
** {{geode-core-1.0.0.jar}} → {{geode-core-2.0.0.jar}} (2 occurrences)
# {{tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb}}
** {{geode-modules-1.0.0.jar}} → {{geode-modules-2.0.0.jar}}
** {{geode-modules-tomcat8-1.0.0.jar}} → {{geode-modules-tomcat8-2.0.0.jar}}
----
h3. 3. WebLogic HTTP Session Management Documentation
{*}File{*}:
{{tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb}}
{*}Problem{*}: Manifest Class-Path and startup examples contained incorrect JAR
versions and outdated Java EE dependencies.
h4. Key Dependency Changes
||Dependency||Old Version||New Version||Notes||
|All geode-* modules|1|2.0.0|Consistent Geode 2.0 versioning|
|javax.transaction-api|1.3|N/A|Removed (Java EE)|
|jakarta.transaction-api|N/A|2.0.1|Added (Jakarta EE 10)|
|jgroups|3.6.14.Final|3.6.20.Final|Updated for stability|
|log4j-*|2.17.1|2.17.2|Security update|
|log4j-slf4j-impl|2.17.1|N/A|Removed|
|log4j-slf4j2-impl|N/A|2.17.2|Updated for SLF4J 2.x|
|slf4j-api|1.7.36|2.0.17|Major version upgrade|
|fastutil|8.2.2|8.5.8|Performance improvements|
h2. Impact Assessment
h3. Documentation Impact
* {*}High{*}: All Java version references across documentation updated
* {*}High{*}: WebLogic integration guide completely revised for Jakarta EE 10
* {*}Medium{*}: Installation guides updated with Java 17 requirements
* {*}Medium{*}: Quick start guides updated with correct JAR versions
h3. User Impact
* {color:#ff0000}*Breaking Change*{color}: Applications using Java 8 must
upgrade to Java 17
* {color:#ff0000}*Breaking Change*{color}: Java EE ({{{}javax){}}}
*applications must migrate to Jakarta EE 10 ({{{}jakarta){}}}*
* {*}Migration Required{*}: Users must update WAR files and dependencies
* {*}Documentation Required{*}: Clear migration path documented for existing
users
h3. Compatibility
* {*}Minimum Java Version{*}: Java 17.0.16 (was Java 8u121)
* {*}Jakarta EE Version{*}: Jakarta EE 10 (was Java EE 8)
* {*}Application Server Compatibility{*}:
** WildFly 31+ (Jakarta EE 10)
** Tomcat 10.1+ (Jakarta EE 10)
** WebLogic 14.1.2+ (with Jakarta EE 10 support)
h2. Acceptance Criteria
* All Java version references updated from Java 8 format to Java 17 format
* All JAR versions updated from 1.0.0 to 2.0.0
* WebLogic manifest updated with Jakarta EE 10 dependencies
* All javax.transaction-api references replaced with jakarta.transaction-api
* Dependency versions updated (slf4j, log4j, jgroups, fastutil)
* Installation guides reflect Java 17 requirements
* No references to Java 8 or Java EE remain
h2. Migration Notes for Users
h3. For Existing Users Upgrading to Geode 2.0
# *Java Version Requirement*
** Minimum: Java 17.0.16 (LTS)
# *Application Server Compatibility*
** Must support Jakarta EE 10
** Recommended: WildFly 31.0.1+, Tomcat 10.1+
# *Dependency Updates Required*
** Replace {{javax.transaction:javax.transaction-api:1.3}}
** With {{jakarta.transaction:jakarta.transaction-api:2.0.1}}
# *Code Changes Required*
** Change all {{javax.transaction}} *imports to {{jakarta.transaction.}}*
** Update application server configuration for Jakarta EE 10
# *WAR File Modification*
** Use updated {{modify_war}} script with Geode 2.0
** Verify all dependencies updated to Jakarta EE 10 versions
> Update Installation Guide for Java Version Requirements
> -------------------------------------------------------
>
> Key: GEODE-10525
> URL: https://issues.apache.org/jira/browse/GEODE-10525
> Project: Geode
> Issue Type: Improvement
> Reporter: Jinwoo Hwang
> Assignee: Jinwoo Hwang
> Priority: Major
> Fix For: 2.0.0
>
>
> h2. Summary
> Update the Apache Geode installation documentation to reflect the current
> supported Java version requirements.
> h2. Description
> The installation guide needs to be updated to ensure users are aware of the
> correct Java version requirements for running Apache Geode. This includes
> updating:
> * Minimum Java version required
> * Recommended Java versions
> * Deprecated Java versions (if any)
> * Any version-specific configuration notes
> h2. Acceptance Criteria
> * Installation guide reflects current Java version requirements
> * All references to Java versions are consistent across documentation
> * Examples and code snippets use supported Java versions
> * Build instructions specify correct Java version
> h2. Documentation Sections to Update
> * Getting Started / Prerequisites
> * Installation Guide
> * Building from Source
> * System Requirements
> h2. Testing
> * Verify documentation builds successfully
> * Ensure all links and references are valid
> * Review for consistency with actual codebase requirements
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
