Elasticsearch

Installation

Install provider

Please install the package from nuget:

dotnet add package Bielu.Examine.Elasticsearch

Add registration

After installation, you need to add registration of the package to your Program.cs file:

First find

.AddBieluExamineForUmbraco()

Extend it by Fluent Configuration in following way

    .AddBieluExamineForUmbraco(bieluExamineConfigurator =>
    {
        bieluExamineConfigurator.AddElasticsearchServices();
    })

Default Recommended configuration

For Local development

Please use following configuration for local development

{
  "bielu": {
    "Examine": {
      "Enabled": true,
      "ElasticSearch": {
        "DevMode": true,
        "DefaultIndexConfiguration": {
          "Name": "ExternalIndex",
          "ConnectionString": "http://localhost:9200",
          "AuthenticationType": "None"
        },
        "IndexConfigurations": [
          {
            "Name": "ExternalIndex"
          },
          {
            "Name": "InternalIndex"
          },
          {
            "Name": "MembersIndex"
          },
          {
            "Name": "DeliveryApiContentIndex"
          }
        ]
      }
    }
  }
}

Configuration schema

This schema correspond to configuration for elasticsearch. It is possible to configure elasticsearch for each index separately or use shared configuration for all indexes.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BieluExamineElasticsearchConfigurationBieluExamineElasticOptions",
  "type": "object",
  "properties": {
    "DevMode": {
      "type": "boolean"
    },
    "IndexConfigurations": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "null"
          },
          {
            "$ref": "#/definitions/BieluExamineElasticsearchConfigurationIndexConfiguration"
          }
        ]
      }
    },
    "DefaultIndexConfiguration": {
      "$ref": "#/definitions/BieluExamineElasticsearchConfigurationIndexConfiguration"
    }
  },
  "definitions": {
    "BieluExamineElasticsearchConfigurationIndexConfiguration": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string"
        },
        "Analyzer": {
          "type": "string"
        },
        "OverrideClientConfiguration": {
          "type": "boolean"
        },
        "ConnectionString": {
          "type": "string"
        },
        "AuthenticationType": {
          "$ref": "#/definitions/BieluExamineElasticsearchConfigurationAuthenticationType"
        },
        "AuthenticationDetails": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/BieluExamineElasticsearchConfigurationAuthenticationDetails"
            }
          ]
        },
        "Prefix": {
          "type": "string"
        }
      }
    },
    "BieluExamineElasticsearchConfigurationAuthenticationType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "None",
        "Cloud",
        "CloudApi"
      ],
      "enum": [
        "None",
        "Cloud",
        "CloudApi"
      ]
    },
    "BieluExamineElasticsearchConfigurationAuthenticationDetails": {
      "type": "object",
      "properties": {
        "Username": {
          "type": "string"
        },
        "Password": {
          "type": "string"
        },
        "ApiKey": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        }
      }
    }
  }
}

DevMode

This flag is responsible by enabling / disabling development mode for elasticsearch, it will enable debug mode on elasticsearch (Docs).

DefaultIndexConfiguration

This is a default index configuration for elasticsearch. Please see OverrideClientConfiguration object description below. This configuration is used as shared configuration, in case when index configuration is not provided or index is not configured with Override Client Configuration flag.

IndexConfigurations

This is a list of index configurations for elasticsearch. Each index configuration is a separate configuration for elasticsearch. It is possible to override default configuration for each index.

Index Configuration

For each index configuration and default configuration it is possible to configure following options:

Name

This is a name of index. This will be use also to store client information when overriding default configuration.

OverrideClientConfiguration

This flag is responsible by enabling / disabling overriding default configuration for elasticsearch client. Default value is false.

Analyzer

This is a name of analyzer for elasticsearch. Default value is standard.

ConnectionString

This is a connection string for elasticsearch. It is required to be able to use elasticsearch.

AuthenticationType

This is a type of authentication for elasticsearch. Default value is none. Currently Available options: None, Cloud, CloudApi.

AuthenticationDetails

This is a details for authentication for elasticsearch. It is required to be able to use elasticsearch, when authentication type is not None.

AuthenticationDetails.Id

This is a username for elasticsearch. It is required to be able to use elasticsearch, when authentication type is Cloud or CloudApi.

AuthenticationDetails.Username

This is a username for elasticsearch. It is required to be able to use elasticsearch, when authentication type is Cloud.

AuthenticationDetails.Password

This is a password for elasticsearch. It is required to be able to use elasticsearch, when authentication type is Cloud.

AuthenticationDetails.ApiKey

This is a api key for elasticsearch. It is required to be able to use elasticsearch, when authentication type is CloudApi.

Last modified: 17 March 2024