accesscontroltool icon indicating copy to clipboard operation
accesscontroltool copied to clipboard

#681 Updated index name to match Cloud Manager new standards

Open diogopedreira opened this issue 1 year ago • 4 comments

Following https://github.com/Netcentric/accesscontroltool/issues/681, the existing index has been renamed in order to be compliant with Adobe's guidelines - https://docs.mktossl.com/docs/experience-manager-cloud-service/content/operations/indexing.html?lang=en#index-names.

Changes:

  • Updated index name
  • Adjusted filter.xml to point to the new name and updated the existing rules to map the approach applied in https://github.com/Netcentric/accesscontroltool/pull/638/files
  • Updated QueryHelper.java to refer to the new index name.

diogopedreira avatar Dec 20 '23 15:12 diogopedreira

According to https://docs.mktossl.com/docs/experience-manager-cloud-service/content/operations/indexing.html?lang=en#index-names the pattern needs to be

<prefix>.<indexName>-<productVersion>-custom-<customVersion>

kwin avatar Dec 22 '23 10:12 kwin

According to https://docs.mktossl.com/docs/experience-manager-cloud-service/content/operations/indexing.html?lang=en#index-names the pattern needs to be

<prefix>.<indexName>-<productVersion>-custom-<customVersion>

@kwin I've followed the pattern that was on the error log and it seems that there are some discrepancies on the standard, on the build result I get

2023-12-22T13:55:26.399Z,Netcentric:accesscontroltool-oakindex-package:3.0.10,0,"Index definition detected at /oak:index/repACL-custom-1. Fully custom index names need to follow the pattern .-custom-, e.g. /oak:index/acme.indexName-custom-1, to be compliant with AEM as a Cloud Service",Code Smell,Minor,,IndexValidFullyCustomName,"aem,cloud-service-compatibility",https://www.adobe.com/go/aem_cmcq_indexvalidfullycusto_en

The URL that they present is now returning a 404 and in here we have a different definition: https://experienceleague.adobe.com/docs/experience-manager-cloud-service/content/operations/indexing.html?lang=en#index-management-without-rolling-deployments

In any case I will take the one you mentioned as it seems to be the new one.

diogopedreira avatar Dec 22 '23 15:12 diogopedreira

The pattern without product version makes a lot more sense to me. Thanks for pointing out the discrepancies in the documentation. If this version does not emit any warning in Cloud Manager I am fine with that

kwin avatar Dec 22 '23 21:12 kwin

@diogopedreira Have you tried to deploy with the node name as proposed in this PR? Does it emit any warnings in CloudManager?

kwin avatar Mar 15 '24 15:03 kwin

The unmodified index definition does no longer emit any issue in the code checks in Cloud Manager, therefore no need to change it right now.

kwin avatar May 06 '24 09:05 kwin