add configuration for search extractor, needs owncloud/ocis#5221

owncloud · Jan 27, 2023 · 19ff9d6 · 19ff9d6
1 parent 08943e7
commit 19ff9d6
Show file tree

Hide file tree

Showing 4 changed files with 122 additions and 0 deletions.
diff --git a/charts/ocis/docs/values-desc-table.adoc b/charts/ocis/docs/values-desc-table.adoc
@@ -690,6 +690,12 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 see detailed service configuration options below
 | IDM service. Not used if `features.externalUserManagement.enabled` equals `true`.
+| services.idm.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.idm.persistence.accessModes
 a| [subs=-attributes]
 +list+
@@ -768,6 +774,12 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 see detailed service configuration options below
 | NATS service.
+| services.nats.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.nats.persistence.accessModes
 a| [subs=-attributes]
 +list+
@@ -882,6 +894,30 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 see detailed service configuration options below
 | SEARCH service.
+| services.search.extractor
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed search extractor configuration options below
+| Search Extractor settings.
+| services.search.extractor.tika.url
+a| [subs=-attributes]
++string+
+a| [subs=-attributes]
+`"http://tika.tika.svc.cluster.local:9998"`
+| Set the URL to Tika. Only applicable if `services.search.extractor.type` == `tika`.
+| services.search.extractor.type
+a| [subs=-attributes]
++string+
+a| [subs=-attributes]
+`"basic"`
+| Configures the search extractor type to be used. Possible extractors: - `basic`: the default search extractor. - `tika`: the Tika search extractor. If set to this value, additional settings in the `tika` section apply.
+| services.search.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.search.persistence.accessModes
 a| [subs=-attributes]
 +list+
@@ -996,6 +1032,12 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 see detailed service configuration options below
 | STORAGE-SYSTEM service.
+| services.storageSystem.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.storageSystem.persistence.accessModes
 a| [subs=-attributes]
 +list+
@@ -1074,6 +1116,12 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 `"* * * * *"`
 | Cron pattern for the job to be run. Defaults to every minute.
+| services.storageUsers.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.storageUsers.persistence.accessModes
 a| [subs=-attributes]
 +list+
@@ -1176,6 +1224,12 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 see detailed service configuration options below
 | STORE service.
+| services.store.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.store.persistence.accessModes
 a| [subs=-attributes]
 +list+
@@ -1242,6 +1296,12 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 see detailed service configuration options below
 | THUMBNAILS service.
+| services.thumbnails.persistence
+a| [subs=-attributes]
++object+
+a| [subs=-attributes]
+see detailed persistence configuration options below
+| Persistence settings.
 | services.thumbnails.persistence.accessModes
 a| [subs=-attributes]
 +list+

diff --git a/charts/ocis/docs/values.adoc.yaml b/charts/ocis/docs/values.adoc.yaml
@@ -419,6 +419,8 @@ services:
   # -- IDM service. Not used if `features.externalUserManagement.enabled` equals `true`.
   # @default -- see detailed service configuration options below
   idm:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations, except `features.externalUserManagement.enabled` equals `true`.
@@ -458,6 +460,8 @@ services:
   # -- NATS service.
   # @default -- see detailed service configuration options below
   nats:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -516,6 +520,18 @@ services:
   # -- SEARCH service.
   # @default -- see detailed service configuration options below
   search:
+    # -- Search Extractor settings.
+    # @default -- see detailed search extractor configuration options below
+    extractor:
+      # -- Configures the search extractor type to be used. Possible extractors:
+      # - `basic`: the default search extractor.
+      # - `tika`: the Tika search extractor. If set to this value, additional settings in the `tika` section apply.
+      type: basic
+      tika:
+        # -- Set the URL to Tika. Only applicable if `services.search.extractor.type` == `tika`.
+        url: http://tika.tika.svc.cluster.local:9998
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -573,6 +589,8 @@ services:
   # -- STORAGE-SYSTEM service.
   # @default -- see detailed service configuration options below
   storageSystem:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -649,6 +667,8 @@ services:
         enabled: false
         # -- Cron pattern for the job to be run. Defaults to every minute.
         schedule: "* * * * *"
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -683,6 +703,8 @@ services:
   # -- STORE service.
   # @default -- see detailed service configuration options below
   store:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -716,6 +738,8 @@ services:
   # -- THUMBNAILS service.
   # @default -- see detailed service configuration options below
   thumbnails:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Is recommended to be enabled on production installations.

diff --git a/charts/ocis/templates/search/deployment.yaml b/charts/ocis/templates/search/deployment.yaml
@@ -77,6 +77,20 @@ spec:
             - name: SEARCH_EVENTS_ENDPOINT
               value: nats:9233
 
+            {{- if  eq .Values.services.search.extractor.type "tika" }}
+            - name: SEARCH_EXTRACTOR_TYPE
+              value: tika
+
+            - name: SEARCH_EXTRACTOR_TIKA_TIKA_URL
+              value: {{ .Values.services.search.extractor.tika.url | quote }}
+            {{- else }}
+            - name: SEARCH_EXTRACTOR_TYPE
+              value: basic
+            {{- end }}
+
+            - name: SEARCH_EXTRACTOR_CS3SOURCE_INSECURE
+              value: {{ .Values.insecure.ocisHttpApiInsecure | quote }}
+
             - name: SEARCH_MACHINE_AUTH_API_KEY
               valueFrom:
                 secretKeyRef:

diff --git a/charts/ocis/values.yaml b/charts/ocis/values.yaml
@@ -418,6 +418,8 @@ services:
   # -- IDM service. Not used if `features.externalUserManagement.enabled` equals `true`.
   # @default -- see detailed service configuration options below
   idm:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations, except `features.externalUserManagement.enabled` equals `true`.
@@ -457,6 +459,8 @@ services:
   # -- NATS service.
   # @default -- see detailed service configuration options below
   nats:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -515,6 +519,18 @@ services:
   # -- SEARCH service.
   # @default -- see detailed service configuration options below
   search:
+    # -- Search Extractor settings.
+    # @default -- see detailed search extractor configuration options below
+    extractor:
+      # -- Configures the search extractor type to be used. Possible extractors:
+      # - `basic`: the default search extractor.
+      # - `tika`: the Tika search extractor. If set to this value, additional settings in the `tika` section apply.
+      type: basic
+      tika:
+        # -- Set the URL to Tika. Only applicable if `services.search.extractor.type` == `tika`.
+        url: http://tika.tika.svc.cluster.local:9998
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -572,6 +588,8 @@ services:
   # -- STORAGE-SYSTEM service.
   # @default -- see detailed service configuration options below
   storageSystem:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -648,6 +666,8 @@ services:
         enabled: false
         # -- Cron pattern for the job to be run. Defaults to every minute.
         schedule: "* * * * *"
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -682,6 +702,8 @@ services:
   # -- STORE service.
   # @default -- see detailed service configuration options below
   store:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Needs to be enabled on production installations.
@@ -715,6 +737,8 @@ services:
   # -- THUMBNAILS service.
   # @default -- see detailed service configuration options below
   thumbnails:
+    # -- Persistence settings.
+    # @default -- see detailed persistence configuration options below
     persistence:
       # -- Enables persistence.
       # Is recommended to be enabled on production installations.