Sign inSign up

folioorg/mod-search

By folioorg

Updated about 1 month ago

Image
0

100K+

folioorg/mod-search repository overview

Code Repository: https://github.com/folio-org/mod-search

Metadata

  • Container memory (bytes): 1073741824
  • Module ports: 8081/tcp

Default environment variables

  • JAVA_OPTIONS:
    • -XX:MaxRAMPercentage=85.0
  • FOLIO database connection: true
  • FOLIO database common environment:
    • DB_DATABASE, DB_HOST, DB_PORT, DB_USERNAME, DB_PASSWORD, DB_CHARSET
  • FOLIO database other environment:
    • DB_MAXPOOLSIZE
      • Default value: 5
    • DB_QUERYTIMEOUT
      • Default value: 60000
  • BROWSE_CALL_NUMBERS_ENABLED
    • Description: Specifies if globally browse instance call-number feature is enabled
    • Default value: true
  • BROWSE_CLASSIFICATIONS_ENABLED
    • Description: Specifies if globally browse instance classification feature is enabled
    • Default value: true
  • BROWSE_CONTRIBUTORS_ENABLED
    • Description: Specifies if globally browse instance contributor feature is enabled
    • Default value: true
  • BROWSE_SUBJECTS_ENABLED
    • Description: Specifies if globally browse instance subject feature is enabled
    • Default value: true
  • ELASTICSEARCH_COMPRESSION_ENABLED
    • Description: Specify if Elasticsearch request/response compression enabled
    • Default value: true
  • ELASTICSEARCH_PASSWORD
    • Description: Elasticsearch password (not required for dev envs)
    • Default value: s3cret
  • ELASTICSEARCH_SERVER
    • Description: Specify whether it is Elasticsearch(true) or Opensearch(false)
    • Default value: false
  • ELASTICSEARCH_URL
    • Description: Elasticsearch URL
    • Default value: http://elasticsearch:9200
  • ELASTICSEARCH_USERNAME
    • Description: Elasticsearch username (not required for dev envs)
    • Default value: elastic
  • ENV
    • Description: The logical name of the deployment, must be unique across all environments using the same shared Kafka/Elasticsearch clusters, a-z (any case), 0-9, -, _ symbols only allowed
    • Default value: folio
  • INDEXING_DATA_FORMAT
    • Description: Format for passing data to elasticsearch (json/smile)
    • Default value: smile
  • INITIAL_LANGUAGES
    • Description: Comma separated list of languages for multilang fields
    • Default value: eng
  • INSTANCE_CHILDREN_INDEX_BATCH_SIZE
    • Description: Batch size for indexing subjects/contributors/classifications
    • Default value: 500
  • INSTANCE_CHILDREN_INDEX_DELAY_MS
    • Description: Scheduler delay for indexing subjects/contributors/classifications
    • Default value: 60000
  • INSTANCE_CHILDREN_INDEX_ENABLED
    • Description: Defines if module should process subjects/contributors/classifications/call-numbers in a background
    • Default value: true
  • KAFKA_AUTHORITIES_CONCURRENCY
    • Description: Custom number of kafka concurrent threads for authority message consuming.
    • Default value: 1
  • KAFKA_AUTHORITIES_CONSUMER_PATTERN
    • Description: Custom subscription pattern for Kafka authority message consumers.
    • Default value: (folio\.)(.*\.)authorities\.authority
  • KAFKA_CONSORTIUM_INSTANCE_SHARING_COMPLETE_CONCURRENCY
    • Description: Custom number of kafka concurrent threads for consortium instance sharing complete message consuming.
    • Default value: 1
  • KAFKA_CONSUMER_EVENTS_MAX_POLL_INTERVAL_MS
    • Description: Maximum processing time allowed for consumer on 'instance|holdings-record|item|bound-with' events.
    • Default value: 600000
  • KAFKA_CONSUMER_EVENTS_MAX_POLL_RECORDS
    • Description: Maximum number of records returned in a single call to poll() for 'instance|holdings-record|item|bound-with' events.
    • Default value: 200
  • KAFKA_CONSUMER_MAX_POLL_RECORDS
    • Description: Maximum number of records returned in a single call to poll().
    • Default value: 200
  • KAFKA_EVENTS_CONCURRENCY
    • Description: Custom number of kafka concurrent threads for message consuming.
    • Default value: 2
  • KAFKA_EVENTS_CONSUMER_PATTERN
    • Description: Custom subscription pattern for Kafka consumers.
    • Default value: (folio\.)(.*\.)inventory\.(instance|holdings-record|item|bound-with)
  • KAFKA_HOST
    • Description: Kafka broker hostname
    • Default value: kafka
  • KAFKA_PORT
    • Description: Kafka broker port
    • Default value: 9092
  • KAFKA_REINDEX_FILE_READY_CONCURRENCY
    • Description: Custom number of kafka concurrent threads for inventory.reindex.file-ready message consuming.
    • Default value: 2
  • KAFKA_REINDEX_RANGE_INDEX_CONCURRENCY
    • Description: Custom number of kafka concurrent threads for search.reindex.range-index message consuming.
    • Default value: 1
  • KAFKA_REINDEX_RANGE_INDEX_TOPIC_PARTITIONS
    • Description: Amount of partitions for search.reindex.range-index topic.
    • Default value: 16
  • KAFKA_REINDEX_RANGE_INDEX_TOPIC_REPLICATION_FACTOR
    • Description: Replication factor for search.reindex.range-index topic.
  • KAFKA_REINDEX_RECORDS_CONCURRENCY
    • Description: Custom number of kafka concurrent threads for inventory.reindex-records message consuming.
    • Default value: 2
  • KAFKA_RETRY_DELIVERY_ATTEMPTS
    • Description: Specifies how many queries attempt to perform after the first one failed.
    • Default value: 6
  • KAFKA_RETRY_INTERVAL_MS
    • Description: Specifies time to wait before reattempting query.
    • Default value: 2000
  • KAFKA_SECURITY_PROTOCOL
    • Description: Kafka security protocol used to communicate with brokers (SSL or PLAINTEXT)
    • Default value: PLAINTEXT
  • KAFKA_SSL_KEYSTORE_LOCATION
    • Description: The location of the Kafka key store file. This is optional for client and can be used for two-way authentication for client.
  • KAFKA_SSL_KEYSTORE_PASSWORD
    • Description: The store password for the Kafka key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured.
  • KAFKA_SSL_TRUSTSTORE_LOCATION
    • Description: The location of the Kafka trust store file.
  • KAFKA_SSL_TRUSTSTORE_PASSWORD
    • Description: The password for the Kafka trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled.
  • MAX_BROWSE_REQUEST_OFFSET
    • Description: The maximum elasticsearch query offset for additional requests on browse around
    • Default value: 500
  • MAX_SEARCH_BATCH_REQUEST_IDS_COUNT
    • Description: Defines maximum batch request IDs count for searching consolidated items/holdings in consortium
    • Default value: 20000
  • MAX_SUPPORTED_LANGUAGES
    • Description: Provides the maximum number of supported languages
    • Default value: 5
  • OKAPI_URL
    • Description: OKAPI URL used to login system user, required
  • REINDEX_LOCATION_BATCH_SIZE
    • Description: Defines number of locations to retrieve per inventory http request on locations reindex process
    • Default value: 1000
  • REINDEX_MERGE_RANGE_PUBLISHER_CORE_POOL_SIZE
    • Description: The number of threads for publishing the merge ranges to keep in the pool, even if they are idle.
    • Default value: 3
  • REINDEX_MERGE_RANGE_PUBLISHER_MAX_POOL_SIZE
    • Description: The maximum number of threads for publishing the merge ranges to allow in the pool.
    • Default value: 6
  • REINDEX_MERGE_RANGE_PUBLISHER_RETRY_ATTEMPTS
    • Description: The maximum number of retries for reindex merge range request publishing.
    • Default value: 5
  • REINDEX_MERGE_RANGE_PUBLISHER_RETRY_INTERVAL_MS
    • Description: The retry interval in ms for reindex merge range request publishing.
    • Default value: 1000
  • REINDEX_MERGE_RANGE_SIZE
    • Description: The range size that represents the number of merge entities to process during the Merge process of reindex
    • Default value: 500
  • REINDEX_TYPE
    • Description: Defines reindex data ingestion strategy: PUBLISH for Kafka payload events, EXPORT for file-ready events from remote storage.
    • Default value: EXPORT
  • REINDEX_UPLOAD_RANGE_LEVEL
    • Description: The level of deepness of upload range generator affecting the number of ranges to be generated
    • Default value: 3
  • REINDEX_UPLOAD_RANGE_SIZE
    • Description: The range size that represents the number of upload entities to process during the Upload process of reindex
    • Default value: 1000
  • S3_REINDEX_ACCESS_KEY_ID
    • Description: Access key ID for remote object storage in reindex EXPORT mode.
  • S3_REINDEX_BUCKET
    • Description: Remote object storage bucket for reindex EXPORT mode.
  • S3_REINDEX_IS_AWS
    • Description: Controls whether AWS-compatible SDK behavior is used for reindex EXPORT remote storage.
    • Default value: true
  • S3_REINDEX_REGION
    • Description: Remote object storage region for reindex EXPORT mode.
    • Default value: us-west-2
  • S3_REINDEX_SECRET_ACCESS_KEY
    • Description: Secret access key for remote object storage in reindex EXPORT mode.
  • S3_REINDEX_URL
    • Description: Remote object storage endpoint for reindex EXPORT mode.
    • Default value: https://s3.amazonaws.com
  • SCROLL_QUERY_SIZE
    • Description: The number of records to be loaded by each scroll query. 10000 is a max value
    • Default value: 1000
  • SEARCH_BY_ALL_FIELDS_ENABLED
    • Description: Specifies if globally search by all field values must be enabled or not (tenant can override this setting)
    • Default value: false
  • SEARCH_QUERY_TIMEOUT
    • Description: The maximum time to wait for search query response
    • Default value: 25s
  • STALE_LOCK_THRESHOLD_MS
    • Description: Threshold to consider a sub-resource lock as stale and eligible for release
    • Default value: 600000
  • STREAM_ID_CORE_POOL_SIZE
    • Description: The number of threads to keep in the pool, even if they are idle.
    • Default value: 2
  • STREAM_ID_MAX_POOL_SIZE
    • Description: The maximum number of threads to allow in the pool.
    • Default value: 2
  • STREAM_ID_QUEUE_CAPACITY
    • Description: The capacity of the queue.
    • Default value: 500
  • STREAM_ID_RETRY_ATTEMPTS
    • Description: Specifies how many queries attempt to perform after the first one failed.
    • Default value: 3
  • STREAM_ID_RETRY_INTERVAL_MS
    • Description: Specifies time to wait before reattempting query.
    • Default value: 1000
  • SUB_RESOURCE_BATCH_SIZE
    • Description: Defines number of sub-resources to process at a time during background indexing
    • Default value: 100
  • SYSTEM_USER_PASSWORD
    • Description: Password for mod-search system user (not required for dev envs)
  • SYSTEM_USER_USERNAME
    • Description: Username for mod-search system user
    • Default value: mod-search

Tag summary

Content type

Image

Digest

sha256:763928769

Size

224.9 MB

Last updated

about 1 month ago

docker pull folioorg/mod-search