Custom resource

OpenSearchCluster

An OpenSearch cluster stacklet. This resource is managed by the Stackable operator for OpenSearch.

View SDP dev release Download CRD (YAML)

API group: opensearch.stackable.tech
API versions in dev: v1alpha1
Scope: Namespaced
Operator: OpenSearch
Roles: 1 (nodes)

Schema

OpenSearchCluster.opensearch.stackable.tech .spec fields for SDP dev.

Schema

nodes # role object required *
This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a key-value-map containing all the roleGroups that are part of this role. Additionally, there is a config, which is configurable at the role and roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level. There is also a second form of config, which can only be configured at role level, the roleConfig. You can learn more about this in the Roles and role group concept documentation.

This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a key-value-map containing all the roleGroups that are part of this role. Additionally, there is a config, which is configurable at the role and roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level. There is also a second form of config, which can only be configured at role level, the roleConfig. You can learn more about this in the Roles and role group concept documentation.
image # object required *
Specify which image to use, the easiest way is to only configure the productVersion. You can also configure a custom image registry to pull from, as well as completely custom images. Consult the Product image selection documentation for details.

Specify which image to use, the easiest way is to only configure the productVersion. You can also configure a custom image registry to pull from, as well as completely custom images. Consult the Product image selection documentation for details.
clusterConfig # object = {"tls":{"serverSecretClass":"tls","internalSecretClass":"tls"},"keystore":[],... Configuration that applies to all roles and role groups

Configuration that applies to all roles and role groups
clusterOperation # object = {"stopped":false,"reconciliationPaused":false}
Cluster operations properties, allow stopping the product instance as well as pausing reconciliation.

Cluster operations properties, allow stopping the product instance as well as pausing reconciliation.
objectOverrides # array = []
A list of generic Kubernetes objects, which are merged into the objects that the operator creates. List entries are arbitrary YAML objects, which need to be valid Kubernetes objects. Read the Object overrides documentation for more information.

A list of generic Kubernetes objects, which are merged into the objects that the operator creates. List entries are arbitrary YAML objects, which need to be valid Kubernetes objects. Read the Object overrides documentation for more information.