Object Service Indexing

One of the primary jobs for the 3LC Object Service is indexing 3LC objects to be accessed through the Dashboard. Indexing is done in the background until the Object Service is terminated.

For details about how the indexing system works see the indexing core concept.

Configuration

Locations that should be indexed are specified in the configuration settings. In particular, the following settings are relevant:

  • indexing.project-root-url: Primary location for writing new projects.

  • indexing.project-scan-urls: Additional locations to scan for projects.

Tables and runs may be written to a particular location by a training notebook or script with 3LC integration or by the Object Service itself when saving a revision made in the Dashboard. The default location is specified by the project-root-url setting.

Additional locations to index are specified using the project-scan-urls values. Note that the project-root-url is effectively added to the project-scan-urls value, so there is no need to specify the same location in both places.

The URLs that are part of these configuration options may be local file paths or cloud storage locations. See the URL Details page for more details.

Service Operation

The indexing system automatically creates scan-URL directories if they don’t already exist and bypasses any scan-URLs that are inaccessible. All indexing issues are recorded by the 3LC logging and can be inspected at log location.

Note

It is necessary to restart the object-service, which also restarts the indexer, whenever there are modifications to the configuration files or relevant changes to the network environment.