Release notes

After starting Augmented Search 3.3.0, a re-indexing of the platform is required. During this initial indexing, the search feature will not be available. This is due to the changes done for file indexing, as the index is built differentely, and new indices are created (jahia_as_v3*). These changes have no impact at API level, meaning that no code change is required when upgrading to Augmented Search 3.3.0. These changes also reduce the weight of files in the search results, compared to page contents, solving an issue where files were appearing too high in the search results. If the impact on the file releavance is too important, you can adjust the file boost configuration.

Follow the steps below to upgrade to Augmented Search 3.3.0:

1. Stop Jahia
2. Set elasticsearch.prefix in jahia.properties (ex: “jahia”)
3. Start Jahia
4. Deploy the newest version of elasticsearch-connector for your platform (3.2.0 for 8.1.0+)
5. Deploy the newest version of jContent for your platform (2.7.0 for 8.1.0+)
   • As there's an incompatibility between the new Augmented Search version and the previous versions of jContent
6. Deploy a recent version of graphql-dxm-provider for your platform (2.8.0+ for 8.1.0+)
   • As it provides the upload feature required by the boost feature in a json file
7. Deploy (but DO NOT start yet) the newest version of augmented-search for your platform (3.3.0 for 8.1.0+)
   • As previously mentioned, starting the new Augmented Search version will make the search unavailable until the first indexation is complete
8. Configure Augmented Search by setting or updating the following properties in org.jahia.modules.augmentedsearch.cfg 
   1. org.jahia.modules.augmentedsearch.prefix (ex: “jahia_as” will make indexes starting with “jahia_as_v3”)
   2. org.jahia.modules.augmentedsearch.numberOfShards (-1 by default - meaning automatically calculated)
   3. org.jahia.modules.augmentedsearch.numberOfReplicas (-1 by default - meaning automatically calculated)
   4. org.jahia.modules.augmentedsearch.maxShardSizeInGb (20 by default)
   5. org.jahia.modules.augmentedsearch.minHeapPerShardInMb (50 by default)
9. Once the configuration has been done, start Augmented Search 3.3.0
10. Start the re-indexing
    This can be done by clicking on Index all in Administration > Server > Configuration > Augmented Search, or using the following GraphQL query:

    mutation {
      admin {
        search {
          startIndex {
            jobs {
              id
              status
              project {
                siteKey
              }
            }
          }
        }
      }
    }

11. After validation of the upgraded environment, remove the jahia_as_v2* indices in your Elasticsearch environment

1. Deploy and start AS 1.7.0
2. Undeploy the previous Augmented Search version(s)
3. Start a reindexing of the platform
   • Several indexing issues are fixed in AS 1.7.0, so we do recommend a reindexing to benefit from them and to have a consistent index. Please note that the search will remain available during this operation, using the previous index. 

After starting Augmented Search 1.6.0, a re-indexing of the platform is required. During this initial indexing, the search feature will not be available. This is due to the changes done for file indexing, as the index is built differentely, and new indices are created (jahia_as_v3*). These changes have no impact at API level, meaning that no code change is required when upgrading to Augmented Search 1.6.0. These changes also reduce the weight of files in the search results, compared to page contents, solving an issue where files were appearing too high in the search results. If the impact on the file releavance is too important, you can adjust the file boost configuration.

Follow the steps below to upgrade to Augmented Search 1.6.0:

1. Stop Jahia
2. Set elasticsearch.prefix in jahia.properties (ex: “jahia”)
3. Start Jahia
4. Deploy the newest version of elasticsearch-connector for your platform (2.1.0 for 7.3.5+)
5. Deploy (but DO NOT start yet) the newest version of augmented-search for your platform (1.6.0 for 7.3.5+)
   1. As previously mentioned, starting the new Augmented Search version will make the search unavailable until the first indexation is complete
6. Add the following properties in org.jahia.modules.augmentedsearch.cfg 
   1. org.jahia.modules.augmentedsearch.prefix (ex: “jahia_as” will make indexes starting with “jahia_as_v3”)
   2. org.jahia.modules.augmentedsearch.numberOfShards (you can use -1 by default - meaning automatically calculated)
   3. org.jahia.modules.augmentedsearch.numberOfReplicas (you can use -1 by default - meaning automatically calculated)
   4. org.jahia.modules.augmentedsearch.maxShardSizeInGb (suggestion to use 20 by default)
   5. org.jahia.modules.augmentedsearch.minHeapPerShardInMb (suggestion to use 50 by default)
7. Once the configuration has been done, start Augmented Search 1.6.0
8. Start the re-indexing using the following GraphQL query:

   mutation {
     admin {
       search {
         startIndex {
           jobs {
             id
             status
             project {
               siteKey
             }
           }
         }
       }
     }
   }

9. After validation of the upgraded environment, remove the jahia_as_v2* indices in your Elasticsearch environment