Skip to content

OpenSearch

Usage example

apiVersion: aiven.io/v1alpha1
kind: OpenSearch
metadata:
  name: my-os
spec:
  authSecretRef:
    name: aiven-token
    key: token

  connInfoSecretTarget:
    name: os-secret
    prefix: MY_SECRET_PREFIX_
    annotations:
      foo: bar
    labels:
      baz: egg

  project: my-aiven-project
  cloudName: google-europe-west1
  plan: startup-4
  disk_space: 80Gib

  maintenanceWindowDow: friday
  maintenanceWindowTime: 23:00:00

OpenSearch

OpenSearch is the Schema for the opensearches API.

Required

  • apiVersion (string). Value aiven.io/v1alpha1.
  • kind (string). Value OpenSearch.
  • metadata (object). Data that identifies the object, including a name string and optional namespace.
  • spec (object). OpenSearchSpec defines the desired state of OpenSearch. See below for nested schema.

spec

Appears on OpenSearch.

OpenSearchSpec defines the desired state of OpenSearch.

Required

  • plan (string, MaxLength: 128). Subscription plan.
  • project (string, Immutable, MaxLength: 63, Format: ^[a-zA-Z0-9_-]+$). Identifies the project this resource belongs to.

Optional

  • authSecretRef (object). Authentication reference to Aiven token in a secret. See below for nested schema.
  • cloudName (string, MaxLength: 256). Cloud the service runs in.
  • connInfoSecretTarget (object). Information regarding secret creation. Exposed keys: OPENSEARCH_HOST, OPENSEARCH_PORT, OPENSEARCH_USER, OPENSEARCH_PASSWORD, OPENSEARCH_CA_CERT. See below for nested schema.
  • connInfoSecretTargetDisabled (boolean, Immutable). When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.
  • disk_space (string, Format: ^[1-9][0-9]*(GiB|G)*). The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service re-balancing.
  • maintenanceWindowDow (string, Enum: monday, tuesday, wednesday, thursday, friday, saturday, sunday). Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
  • maintenanceWindowTime (string, MaxLength: 8). Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
  • projectVPCRef (object). ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically. See below for nested schema.
  • projectVpcId (string, MaxLength: 36). Identifier of the VPC the service should be in, if any.
  • serviceIntegrations (array of objects, Immutable, MaxItems: 1). Service integrations to specify when creating a service. Not applied after initial service creation. See below for nested schema.
  • tags (object, AdditionalProperties: string). Tags are key-value pairs that allow you to categorize services.
  • technicalEmails (array of objects, MaxItems: 10). Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. See below for nested schema.
  • terminationProtection (boolean). Prevent service from being deleted. It is recommended to have this enabled for all services.
  • userConfig (object). OpenSearch specific user configuration options. See below for nested schema.

authSecretRef

Appears on spec.

Authentication reference to Aiven token in a secret.

Required

  • key (string, MinLength: 1).
  • name (string, MinLength: 1).

connInfoSecretTarget

Appears on spec.

Information regarding secret creation. Exposed keys: OPENSEARCH_HOST, OPENSEARCH_PORT, OPENSEARCH_USER, OPENSEARCH_PASSWORD, OPENSEARCH_CA_CERT.

Required

  • name (string). Name of the secret resource to be created. By default, it is equal to the resource name.

Optional

  • annotations (object, AdditionalProperties: string). Annotations added to the secret.
  • labels (object, AdditionalProperties: string). Labels added to the secret.
  • prefix (string). Prefix for the secret's keys. Added "as is" without any transformations. By default, is equal to the kind name in uppercase + underscore, e.g. KAFKA_, REDIS_, etc.

projectVPCRef

Appears on spec.

ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically.

Required

  • name (string, MinLength: 1).

Optional

serviceIntegrations

Appears on spec.

Service integrations to specify when creating a service. Not applied after initial service creation.

Required

technicalEmails

Appears on spec.

Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.

Required

  • email (string, Format: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$). Email address.

userConfig

Appears on spec.

OpenSearch specific user configuration options.

Optional

  • additional_backup_regions (array of strings, MaxItems: 1). Additional Cloud Regions for Backup Replication.
  • custom_domain (string, MaxLength: 255). Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
  • disable_replication_factor_adjustment (boolean). DEPRECATED: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.
  • index_patterns (array of objects, MaxItems: 512). Index patterns. See below for nested schema.
  • index_template (object). Template settings for all new indexes. See below for nested schema.
  • ip_filter (array of objects, MaxItems: 1024). Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16. See below for nested schema.
  • keep_index_refresh_interval (boolean). Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
  • max_index_count (integer, Minimum: 0). DEPRECATED: use index_patterns instead.
  • openid (object). OpenSearch OpenID Connect Configuration. See below for nested schema.
  • opensearch (object). OpenSearch settings. See below for nested schema.
  • opensearch_dashboards (object). OpenSearch Dashboards settings. See below for nested schema.
  • opensearch_version (string, Enum: 1, 2). OpenSearch major version.
  • private_access (object). Allow access to selected service ports from private networks. See below for nested schema.
  • privatelink_access (object). Allow access to selected service components through Privatelink. See below for nested schema.
  • project_to_fork_from (string, Immutable, Pattern: ^[a-z][-a-z0-9]{0,63}$|^$, MaxLength: 63). Name of another project to fork a service from. This has effect only when a new service is being created.
  • public_access (object). Allow access to selected service ports from the public Internet. See below for nested schema.
  • recovery_basebackup_name (string, Pattern: ^[a-zA-Z0-9-_:.]+$, MaxLength: 128). Name of the basebackup to restore in forked service.
  • saml (object). OpenSearch SAML configuration. See below for nested schema.
  • service_log (boolean). Store logs for the service so that they are available in the HTTP API and console.
  • service_to_fork_from (string, Immutable, Pattern: ^[a-z][-a-z0-9]{0,63}$|^$, MaxLength: 64). Name of another service to fork from. This has effect only when a new service is being created.
  • static_ips (boolean). Use static public IP addresses.

index_patterns

Appears on spec.userConfig.

Index patterns.

Required

  • max_index_count (integer, Minimum: 0). Maximum number of indexes to keep.
  • pattern (string, Pattern: ^[A-Za-z0-9-_.*?]+$, MaxLength: 1024). fnmatch pattern.

Optional

  • sorting_algorithm (string, Enum: alphabetical, creation_date). Deletion sorting algorithm.

index_template

Appears on spec.userConfig.

Template settings for all new indexes.

Optional

  • mapping_nested_objects_limit (integer, Minimum: 0, Maximum: 100000). The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.
  • number_of_replicas (integer, Minimum: 0, Maximum: 29). The number of replicas each primary shard has.
  • number_of_shards (integer, Minimum: 1, Maximum: 1024). The number of primary shards that an index should have.

ip_filter

Appears on spec.userConfig.

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Required

  • network (string, MaxLength: 43). CIDR address block.

Optional

  • description (string, MaxLength: 1024). Description for IP filter list entry.

openid

Appears on spec.userConfig.

OpenSearch OpenID Connect Configuration.

Required

  • client_id (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The ID of the OpenID Connect client configured in your IdP. Required.
  • client_secret (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The client secret of the OpenID Connect client configured in your IdP. Required.
  • connect_url (string, MaxLength: 2048). The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.
  • enabled (boolean). Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider.

Optional

  • header (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). HTTP header name of the JWT token. Optional. Default is Authorization.
  • jwt_header (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization.
  • jwt_url_parameter (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.
  • refresh_rate_limit_count (integer, Minimum: 10). The maximum number of unknown key IDs in the time frame. Default is 10. Optional.
  • refresh_rate_limit_time_window_ms (integer, Minimum: 10000). The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds).
  • roles_key (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.
  • scope (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
  • subject_key (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

opensearch

Appears on spec.userConfig.

OpenSearch settings.

Optional

  • action_auto_create_index_enabled (boolean). Explicitly allow or block automatic creation of indices. Defaults to true.
  • action_destructive_requires_name (boolean). Require explicit index names when deleting.
  • auth_failure_listeners (object). Opensearch Security Plugin Settings. See below for nested schema.
  • cluster_max_shards_per_node (integer, Minimum: 100, Maximum: 10000). Controls the number of shards allowed in the cluster per data node.
  • cluster_routing_allocation_node_concurrent_recoveries (integer, Minimum: 2, Maximum: 16). How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
  • email_sender_name (string, Pattern: ^[a-zA-Z0-9-_]+$, MaxLength: 40). Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore.
  • email_sender_password (string, Pattern: ^[^\x00-\x1F]+$, MaxLength: 1024). Sender password for Opensearch alerts to authenticate with SMTP server.
  • email_sender_username (string, Pattern: ^[^\x00-\x1F]+$, MaxLength: 320). Sender username for Opensearch alerts.
  • enable_security_audit (boolean). Enable/Disable security audit.
  • http_max_content_length (integer, Minimum: 1, Maximum: 2147483647). Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
  • http_max_header_size (integer, Minimum: 1024, Maximum: 262144). The max size of allowed headers, in bytes.
  • http_max_initial_line_length (integer, Minimum: 1024, Maximum: 65536). The max length of an HTTP URL, in bytes.
  • indices_fielddata_cache_size (integer, Minimum: 3, Maximum: 100). Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
  • indices_memory_index_buffer_size (integer, Minimum: 3, Maximum: 40). Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
  • indices_memory_max_index_buffer_size (integer, Minimum: 3, Maximum: 2048). Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
  • indices_memory_min_index_buffer_size (integer, Minimum: 3, Maximum: 2048). Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
  • indices_queries_cache_size (integer, Minimum: 3, Maximum: 40). Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
  • indices_query_bool_max_clause_count (integer, Minimum: 64, Maximum: 4096). Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
  • indices_recovery_max_bytes_per_sec (integer, Minimum: 40, Maximum: 400). Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
  • indices_recovery_max_concurrent_file_chunks (integer, Minimum: 2, Maximum: 5). Number of file chunks sent in parallel for each recovery. Defaults to 2.
  • ism_enabled (boolean). Specifies whether ISM is enabled or not.
  • ism_history_enabled (boolean). Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
  • ism_history_max_age (integer, Minimum: 1, Maximum: 2147483647). The maximum age before rolling over the audit history index in hours.
  • ism_history_max_docs (integer, Minimum: 1). The maximum number of documents before rolling over the audit history index.
  • ism_history_rollover_check_period (integer, Minimum: 1, Maximum: 2147483647). The time between rollover checks for the audit history index in hours.
  • ism_history_rollover_retention_period (integer, Minimum: 1, Maximum: 2147483647). How long audit history indices are kept in days.
  • override_main_response_version (boolean). Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
  • plugins_alerting_filter_by_backend_roles (boolean). Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
  • reindex_remote_whitelist (array of strings, MaxItems: 32). Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
  • script_max_compilations_rate (string, MaxLength: 1024). Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
  • search_max_buckets (integer, Minimum: 1, Maximum: 1000000). Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
  • thread_pool_analyze_queue_size (integer, Minimum: 10, Maximum: 2000). Size for the thread pool queue. See documentation for exact details.
  • thread_pool_analyze_size (integer, Minimum: 1, Maximum: 128). Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
  • thread_pool_force_merge_size (integer, Minimum: 1, Maximum: 128). Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
  • thread_pool_get_queue_size (integer, Minimum: 10, Maximum: 2000). Size for the thread pool queue. See documentation for exact details.
  • thread_pool_get_size (integer, Minimum: 1, Maximum: 128). Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
  • thread_pool_search_queue_size (integer, Minimum: 10, Maximum: 2000). Size for the thread pool queue. See documentation for exact details.
  • thread_pool_search_size (integer, Minimum: 1, Maximum: 128). Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
  • thread_pool_search_throttled_queue_size (integer, Minimum: 10, Maximum: 2000). Size for the thread pool queue. See documentation for exact details.
  • thread_pool_search_throttled_size (integer, Minimum: 1, Maximum: 128). Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
  • thread_pool_write_queue_size (integer, Minimum: 10, Maximum: 2000). Size for the thread pool queue. See documentation for exact details.
  • thread_pool_write_size (integer, Minimum: 1, Maximum: 128). Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

auth_failure_listeners

Appears on spec.userConfig.opensearch.

Opensearch Security Plugin Settings.

Optional

internal_authentication_backend_limiting

Appears on spec.userConfig.opensearch.auth_failure_listeners.

Optional

  • allowed_tries (integer, Minimum: 0, Maximum: 2147483647). The number of login attempts allowed before login is blocked.
  • authentication_backend (string, Enum: internal, MaxLength: 1024). internal_authentication_backend_limiting.authentication_backend.
  • block_expiry_seconds (integer, Minimum: 0, Maximum: 2147483647). The duration of time that login remains blocked after a failed login.
  • max_blocked_clients (integer, Minimum: 0, Maximum: 2147483647). internal_authentication_backend_limiting.max_blocked_clients.
  • max_tracked_clients (integer, Minimum: 0, Maximum: 2147483647). The maximum number of tracked IP addresses that have failed login.
  • time_window_seconds (integer, Minimum: 0, Maximum: 2147483647). The window of time in which the value for allowed_tries is enforced.
  • type (string, Enum: username, MaxLength: 1024). internal_authentication_backend_limiting.type.
ip_rate_limiting

Appears on spec.userConfig.opensearch.auth_failure_listeners.

IP address rate limiting settings.

Optional

  • allowed_tries (integer, Minimum: 1, Maximum: 2147483647). The number of login attempts allowed before login is blocked.
  • block_expiry_seconds (integer, Minimum: 1, Maximum: 36000). The duration of time that login remains blocked after a failed login.
  • max_blocked_clients (integer, Minimum: 0, Maximum: 2147483647). The maximum number of blocked IP addresses.
  • max_tracked_clients (integer, Minimum: 0, Maximum: 2147483647). The maximum number of tracked IP addresses that have failed login.
  • time_window_seconds (integer, Minimum: 1, Maximum: 36000). The window of time in which the value for allowed_tries is enforced.
  • type (string, Enum: ip, MaxLength: 1024). The type of rate limiting.

opensearch_dashboards

Appears on spec.userConfig.

OpenSearch Dashboards settings.

Optional

  • enabled (boolean). Enable or disable OpenSearch Dashboards.
  • max_old_space_size (integer, Minimum: 64, Maximum: 2048). Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch.
  • opensearch_request_timeout (integer, Minimum: 5000, Maximum: 120000). Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch.

private_access

Appears on spec.userConfig.

Allow access to selected service ports from private networks.

Optional

  • opensearch (boolean). Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
  • opensearch_dashboards (boolean). Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
  • prometheus (boolean). Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

Appears on spec.userConfig.

Allow access to selected service components through Privatelink.

Optional

public_access

Appears on spec.userConfig.

Allow access to selected service ports from the public Internet.

Optional

  • opensearch (boolean). Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
  • opensearch_dashboards (boolean). Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
  • prometheus (boolean). Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

saml

Appears on spec.userConfig.

OpenSearch SAML configuration.

Required

  • enabled (boolean). Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider.
  • idp_entity_id (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.
  • idp_metadata_url (string, MinLength: 1, MaxLength: 2048). The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.
  • sp_entity_id (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 1024). The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

Optional

  • idp_pemtrustedcas_content (string, MaxLength: 16384). This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.
  • roles_key (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 256). Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions.
  • subject_key (string, Pattern: ^[^\r\n]*$, MinLength: 1, MaxLength: 256). Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default.