Uploaded image for project: 'Geode'
  1. Geode
  2. GEODE-6867

Fix documentation for session state caching

    Details

    • Type: Bug
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: docs, http session
    • Labels:

      Description

      This story outlines two major issues in the session state docs, but I think the docs deserve a fairly comprehensive review to determine if there is any other stale/incorrect information.  The two issues are:

      1. Required jar list is missing some required jars
      2. Need to indicate that a locator MUST be available for peer-to-peer topology

      More details on both issues below:

      We should review the session state documentation for completeness/correctness.  When attempting to install and configure the Tomcat and AppServer session modules by following the docs, I found that there were missing jars in the [installation section|https://gemfire.docs.pivotal.io/98/geode/tools_modules/http_session_mgmt/tomcat_installing_the_module.html] for Tomcat and [setting up section|https://gemfire.docs.pivotal.io/98/geode/tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html].  Namely, I had to add these missing jars (as of 9.8, maybe earlier).

      • micrometer-core jar
      • geode-commons jar
      • geode-management jar

      The first is a new jar added since this documentation was written, and I'm assuming the code was restructured to require the other two jars as dependencies.  I'm not sure how we can ensure that this list is up to date.  Some of our system level tests for session state have to include the same list.  From TomcatInstall.java:

      private static final String[] tomcatRequiredJars =
       {"antlr", "commons-io", "commons-lang", "commons-validator", "fastutil", "geode-common",
       "geode-core", "geode-management", "javax.transaction-api", "jgroups", "log4j-api",
       "log4j-core", "log4j-jul", "micrometer", "shiro-core", "jetty-server", "jetty-util",
       "jetty-http", "jetty-io"};

      And you can see that this list was updated to make the tests pass when dependencies changed.

      The other major issue I found while running through the steps is that you MUST start a locator in the peer-to-peer topology for session state, because multicast UDP discovery is not available/supported in Geode.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                rmcmahon Ryan McMahon
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated: