Configurationedit
Upgrade the Enterprise Search specificationedit
You can upgrade the Enterprise Search version or change settings by editing the YAML specification. ECK will apply the changes by performing a rolling restart of Enterprise Search pods.
Customize Enterprise Search configurationedit
ECK sets up a default Enterprise Search configuration. To customize it, use the config element in the specification.
At a minimum, you must set both ent_search.external_url and kibana.host to the desired URLs.
apiVersion: enterprisesearch.k8s.elastic.co/v1
kind: EnterpriseSearch
metadata:
name: enterprise-search-quickstart
spec:
version: 8.13.2
count: 1
elasticsearchRef:
name: quickstart
config:
# define the exposed URL at which users will reach Enterprise Search
ent_search.external_url: https://my-custom-domain:3002
# define the exposed URL at which users will reach Kibana
kibana.host: https://kibana.my-custom-domain:5601
# configure app search document size limit
app_search.engine.document_size.limit: 100kb
Reference Kubernetes Secrets for sensitive settingsedit
Sensitive settings are best stored in Kubernetes Secrets, referenced in the Enterprise Search specification.
This example sets up a Secret with SMTP credentials:
apiVersion: enterprisesearch.k8s.elastic.co/v1
kind: EnterpriseSearch
metadata:
name: enterprise-search-quickstart
spec:
version: 8.13.2
count: 1
elasticsearchRef:
name: quickstart
config:
ent_search.external_url: https://my-custom-domain:3002
kibana.host: https://kibana.my-custom-domain:5601
configRef:
secretName: smtp-credentials
---
kind: Secret
apiVersion: v1
metadata:
name: smtp-credentials
stringData:
enterprise-search.yml: |-
email.account.enabled: true
email.account.smtp.auth: plain
email.account.smtp.starttls.enable: false
email.account.smtp.host: 127.0.0.1
email.account.smtp.port: 25
email.account.smtp.user: myuser
email.account.smtp.password: mypassword
email.account.email_defaults.from: my@email.com
ECK merges the content of config and configRef into a single internal Secret. In case of duplicate settings, the configRef secret has precedence.
Customize the Pod templateedit
You can override the Enterprise Search Pods specification through the podTemplate element.
This example overrides the default 4Gi deployment to use 8Gi instead, and makes the deployment highly-available with 3 Pods:
apiVersion: enterprisesearch.k8s.elastic.co/v1
kind: EnterpriseSearch
metadata:
name: enterprise-search-quickstart
spec:
version: 8.13.2
count: 3
elasticsearchRef:
name: quickstart
podTemplate:
spec:
containers:
- name: enterprise-search
resources:
requests:
cpu: 3
memory: 8Gi
limits:
memory: 8Gi
env:
- name: JAVA_OPTS
value: -Xms7500m -Xmx7500m
Expose Enterprise Searchedit
By default ECK manages self-signed TLS certificates to secure the connection to Enterprise Search. It also restricts the Kubernetes service to ClusterIP type that cannot be accessed publicly.
Check how to access Elastic Stack services to customize TLS settings and expose the service.
When exposed outside the scope of localhost, make sure to set both ent_search.external_url, and kibana.host accordingly in the Enterprise Search configuration.
Customize the connection to an Elasticsearch clusteredit
The elasticsearchRef element allows ECK to automatically configure Enterprise Search to establish a secured connection to a managed Elasticsearch cluster. By default it targets all nodes in your cluster. If you want to direct traffic to specific nodes of your Elasticsearch cluster, refer to Traffic Splitting for more information and examples.
Connect to an external Elasticsearch clusteredit
If you do not want to use the elasticsearchRef mechanism or if you want to connect to an Elasticsearch cluster not managed by ECK, you can manually configure Enterprise Search to access any available Elasticsearch cluster:
apiVersion: enterprisesearch.k8s.elastic.co/v1
kind: EnterpriseSearch
metadata:
name: enterprise-search-quickstart
spec:
version: 8.13.2
count: 1
configRef:
secretName: elasticsearch-credentials
---
kind: Secret
apiVersion: v1
metadata:
name: elasticsearch-credentials
stringData:
enterprise-search.yml: |-
elasticsearch.host: <a href="https://elasticsearch-url:9200" class="ulink" target="_top">https://elasticsearch-url:9200</a>
elasticsearch.username: elastic
elasticsearch.password: my-password
elasticsearch.ssl.enabled: true