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

Documentation review - Administration and configuration Guide - chapters VI - X

XMLWordPrintable

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

      Link to the reviewed guide http://docbuilder.usersys.redhat.com/23161/

      The following are suggestions for improvements in reviewed documentation. It is mostly wrong configuration or old versions.

      I assumed that all programmatic configuration should be moved developer guide, if that's not the case please ignore suggestions bellow to move chapters to developers guide.

      13.3.7. Configure Locking Mode (Library Mode)
      <transaction transactionManagerLookupClass="

      {TransactionManagerLookupClass}"
      transactionMode="{TRANSACTIONAL,NON_TRANSACTIONAL}"
      lockingMode="{OPTIMISTIC,PESSIMISTIC}"
      useSynchronization="true">
      </transaction>

      Set the lockingMode value to OPTIMISTIC or PESSIMISTIC to configure the locking mode used for the transactional cache.

      Should be:
      <transaction transaction-manager-lookup="{TransactionManagerLookupClass}

      "
      mode="

      {NONE, BATCH, NON_XA, NON_DURABLE_XA, FULL_XA}

      "
      locking="

      {OPTIMISTIC,PESSIMISTIC}

      ">
      </transaction>

      Set the locking value to OPTIMISTIC or PESSIMISTIC to configure the locking mode used for the transactional cache.

      This chapter should be moved to developer guide:
      16.2.3. Configure the Cache Store Programmatically

      16.4. Connection Factories

      • Shouldn't there be sub chapter about PooledConnectionFactory?

      17.2. Cache Store Configuration Details (Library Mode)

      • this cache store can bounded by a maximum number
        should be:
      • this cache store can be bounded by a maximum number

      17.4. Single File Cache Store
      Full stop missing at the end of the sentence.
      .... lead to data loss which is undesirable in this use case

      17.4.3. Upgrade JBoss Data Grid Cache Stores
      Red Hat JBoss Data Grid stores data in a different format than previous versions of JBoss Data Grid.

      There should be version reference:
      Red Hat JBoss Data Grid 7 stores data in a different format than previous versions of JBoss Data Grid.

      17.4.3. Upgrade JBoss Data Grid Cache Stores
      This paragraph talks about rolling upgrades in library mode, but next one says they are only available in clients-server mode. I suggest removing part about library mode.

      Rolling upgrades is the process by which a JBoss Data Grid installation is upgraded without a service shutdown. In Library mode, it refers to a node installation where JBoss Data Grid is running in Library mode. For JBoss Data Grid servers, it refers to the server side components. The upgrade can be due to either hardware or software change such as upgrading JBoss Data Grid.
      Rolling upgrades are only available in JBoss Data Grid's Remote Client-Server mode.

      17.6.3.3. JdbcMixedStore Programmatic Configuration and Procedure 17.3. Configure JdbcMixedStore Programmatically
      should be moved to Developer guide

      Sample config is wrong in these chapters followed by correct line:
      17.5.2. LevelDB Cache Store Sample XML Configuration (Library Mode)
      <leveldb-store xmlns="urn:infinispan:config:store:leveldb:8.0

      17.6.1.2. JdbcBinaryStore Configuration (Library Mode)
      <infinispan
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="urn:infinispan:config:8.3 http://www.infinispan.org/schemas/infinispan-config-8.3.xsd
      urn:infinispan:config:store:jdbc:8.0 http://www.infinispan.org/schemas/infinispan-cachestore-jdbc-config-8.0.xsd"
      xmlns="urn:infinispan:config:8.3">
      <!-- Additional configuration elements here -->
      <persistence>
      <binary-keyed-jdbc-store xmlns="urn:infinispan:config:jdbc:8.0"

      Please make the same version modifications as above to the 2 following chapters
      17.6.2.2. JdbcStringBasedStore Configuration (Library Mode)

      • also replace urn:infinispan:config:jdbc with urn:infinispan:config:store:jdbc
        17.6.3.2. JdbcMixedStore Configuration (Library Mode)
      • also replace urn:infinispan:config:jdbc with urn:infinispan:config:store:jdbc

      17.8.1. JPA Cache Store Sample XML Configuration (Library Mode)
      <jpa-store xmlns="urn:infinispan:config:store:jpa:8.0"

      Procedure 17.7. Download JBoss Data Grid Source Code
      There is reference to 6.6.0 version, should be 7.0.0

      Procedure 17.8. Generate a Maven Archetype
      reference to 6.6.0 maven repository and 6.4.0. version

      17.8.1. JPA Cache Store Sample XML Configuration (Library Mode)
      <jpa-store xmlns="urn:infinispan:config:store:jpa:8.0"

      17.8.3. Deploying JPA Cache Stores in Various Containers
      reference to 6.4.0.Final-redhat-4 dependency version

      Procedure 17.5. Deploy JPA Cache Stores in JBoss EAP 6.3.x and earlier
      reference to JDG 6.6

      Procedure 17.6. Deploy JPA Cache Stores in JBoss EAP 6.4 and later
      reference to JDG 6.6.

      Example 18.1. Toggle Passivation in Remote Client-Server Mode
      <!-- Additional configuration elements here --> this comment is there twice

      20.4. Enable JMX for Cache Instances
      the following chapters should be moved to developer guide:
      Enable JMX Programmatically at the Cache Level
      Enable JMX Programmatically at the CacheManager Level
      Set a CacheManager Name Programmatically
      To Add the Fully Qualified Domain Name Programmatically

      21.6.4. Create a New Cache Using JBoss Operations Network (JON)
      repeated word:
      From from the JBoss Operations Network ...

              rhn-support-chuffman Christian Huffman
              rmacor Roman Macor (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: