Uploaded image for project: 'Red Hat Data Grid'
  1. Red Hat Data Grid
  2. JDG-496

Administration and configuration guide review, chapters 23-39

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • JDG 7.0.0 CR1
    • None
    • Documentation
    • None

      Hi, these are the problems I noticed in the documentation:

      23.4.1. "and four Endpoints attached to it" - In the picture there are only 3
      ⁠23.5.1. there is actually step 6. where the "restart required" window pops up
      Procedure 23.3, step 2 - I don't see any status checkboxes
      Procedure 23.3, step 2 - the Figure 23.9 "Caches view" is the same as Figure 23.10 "Cache statistics" - I suppose 23.9 was meant to be something else?
      23.5.2 - the sentence "The name of the nodes are displayed in the Name column." feels weird...
      Figure 23.35 - in ER9, I only see the Nodes tab, not the other ones
      Figures 23.32, 23.39, 23.40 and 23.41, 23.44, 23.45, 23.46, 23.49 are named just 'Title'
      Figure 23.42 - ER9 shows zero values, not empty fields (like 0 ms)
      Figure 23.49 looks different in ER9
      23.7.6.2 - "To a cluster" - verb is missing
      23.7.6.2 - personally I'd rename this to "Cluster start", since in IT 'restart' usually means 'stop and start' as 1 action
      Figure 23.50 - ER9 looks different - refresh has it's own button, and is not a part of options
      24.4 "and configuration examples for JBoss EAP's LDAP Login Module are found:" i think 'are below' instead of 'are found' is better
      24.4 - this seems to talk about EAP, does it mean this section only applies when library mode is used inside EAP? Or also for server mode? The point of this whole section is unclear.
      24.6 Map/Reduce was removed (there is 1 more mention of it in 17.10)
      24.6 "The JBoss Data Grid distribution includes an example policy file" an exact location could be useful, I can't find it
      24.6 and 24.7 - some connection between JDG security and Java Security Manager would be useful, their relationship is unclear - why do I need to define a policy for the Security Manager?
      24.8.2 step 3 - 'about the new role' - what new role?
      "Run the following command to create a pointer a file named" makes no sense
      24.8.3 step 3 - "By default, the only available realm is ApplicationRealm." this is not true, ManagementRealm is also available
      Procedure 24.6 - step 1 - change urn:infinispan:server:endpoint:6.1 to urn:infinispan:server:endpoint:8.0 (there are multiple instances of old namespaces in the guide, for example jgroups:6.1, core:6.1 etc)
      step 2 - change 'Platform 6' to 'Platform 7', as JDG7 is based on EAP7
      24.9.3 should be renamed or removed, since there is no security for the memcached interface
      25.3.2 - "See the Configure JGroups (Library Mode) section in the Red Hat JBoss Data Grid Administration and Configuration Guide for instructions" - couldn't those be clickable links?
      25.3.3 - "There is no keystore" - I don't understand how this can work without public/private keys, also the next section 25.3.4 mentions "keyStoreName File on classpath that contains keystore repository."
      26.1.1 - why is this talking about starting the server, when the chapter is about library mode cli "26.1. Red Hat JBoss Data Grid Library Mode CLI"? Also the instructions do not work for library - when I start JDG using just infinispan-embedded.jar, and run bin/cli.sh from the library distribution, connect jmx://localhost:12000 doesn't work (even when I start the application with -Dcom.sun.management.jmxremote.port=12000 -Dcom.sun.management.jmxremote.authenticate=false )
      26.3.4 - the command was renamed to clearcache
      27.2.1 - the configuration is outdated, this is how a configuration of a distributed cache with l1 enabled could look like:

      <distributed-cache name="distributed_cache" owners="2" l1-lifespan="20000" l1-cleanup-interval="60000" />

      . L1 is disabled by default, and is enabled by setting a positive value for the l1-lifespan attribute.
      27.2.2 - "The following sample configuration shows the L1 cache default values" I don't see any default values, just the ${VALUE} placeholder.
      28.2.1 - the <versioning> element has no 'enabled' attribute. Versioning is turned on by setting its versioningScheme to SIMPLE, by default it's NONE. Since the Procedure is called "Configure Transactions in Library Mode", we may want to actually show and explain how to configure transactions instead of "<!-- Additional configuration information here -->"
      29.1.2 - "Socket bindings provide a named the combination of interface and port." something is missing here
      Example 29.3 - "The following example uses UDP to automatically detect additional nodes on the network:" this is not true, the snippet defines only UDP as transport, no discovery protocol is defined
      29.2 - the snippet is outdated, correct one should look like this:

      <infinispan xmlns="urn:infinispan:config:8.3">
          <jgroups>
              <stack-file name="jgroupsStack" path="/path/to/jgroups/xml/jgroups.xml}"/>
          </jgroups>
          <cache-container name="default" default-cache="default">
              <transport stack="jgroupsStack" lock-timeout="600000" cluster="default" />
          </cache-container>
      </infinispan>

      29.2.1.2 I'd remove the second bullet point, the first one is enough (also the "or one to each member" doesn't make sense). I'd also remove the sentence about Hot Rod, not sure why it's there.
      29.2.2 also default-configs/default-jgroups-google.xml is available (it is also mentioned in chapter 31)
      29.2.2.2 the names of the properties are wrong, correct ones are jgroups.mping.mcast_addr and jgroups.mping.mcast_port
      29.3.1 JDG 7.0.0 is missing
      30.3 what is meant by "that the console's address will". What console? (also in 31.3)
      32 - Spring 3 was indeed removed in JDG 7.0.0
      33.3 - the attributes were renamed to: cluster, machine, rack, site.
      34.2 - the configuration is outdated, should be

              <subsystem xmlns="urn:infinispan:server:jgroups:8.0">
                  <channels default="cluster">
                      <channel name="cluster"/>
                      <channel name="xsite" stack="tcp"/>
                  </channels>
                  <stacks default="udp">
                      <stack name="udp">
      		            <transport type="UDP" socket-binding="jgroups-udp"/>
                          <...other protocols...>
                          <relay site="LON">
                              <remote-site name="NYC" channel="xsite"/>
                              <remote-site name="SFO" channel="xsite"/>
                          </relay>
                      </stack>
                  </stacks>
              </subsystem>

      We also have an example configuration in <jdg-server-dir>/docs/examples/configs/clustered-xsite.xml
      "The RELAY protocol creates an additional stack (running parallel to the existing TCP stack)" - the existing stack is UDP, though.
      34.2.2.1 - the configuration is outdated
      34.3.2 - the attributes are named the same as in 34.3.1 (BTW the configuration was changed in 7.0.0 so that library and server are both configured the same (or at least very similarly in most cases), so it might be worth to merge some sections which are now separate for library and server mode)
      35.1 - JDG 7.0.0 is missing in the important bubble
      36.2 - there is no longer <properties> element, <property> elements are defined directly in the <interceptor>. 'after' and 'before' are also attributes (like 'position' and 'index').
      38.3 - compatibility has no 'enabled' attribute. But it has a 'marshaller' attribute.
      39.6 - the library configuration is outdated, should be

      <distributed-cache name="distributed_cache" owners="2" l1-lifespan="20000">
          <partition-handling enabled="true"/>
      </distributed-cache>

      and the namespace in the server snippet should be 'urn:infinispan:server:core:8.3'

            rhn-support-chuffman Christian Huffman
            jmarkos Jakub Markos (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: