Era Software

No results match your query

Configuration options reference

Estimated reading time: 2 minutes
  • reference
  • self-hosted

This page describes EraSearch's configuration files and options. Use it to customize self-hosted EraSearch to your environment and logging needs.

Note: This page is in progress. The current version (as of May 2, 2022) describes EraSearch's configuration files and how to use them. Future versions will outline and give guidance on EraSearch's configuration options. Be sure to revisit this page in the coming weeks for more information!

Configuration files
Copy
Copied!

For self-hosted EraSearch
Copy
Copied!

Self-hosted EraSearch uses Helm – a package manager for Kubernetes – for configuring and deploying releases into Kubernetes clusters. All self-hosted instances come with these files:

  • eradb-registry-xxxx.json - The authentication credentials for pulling images from Era Software's container registry.
  • eradb-x.x.x.tgz - Compressed files with Helm charts for installing EraSearch into a Kubernetes cluster.
  • values-eradb.yaml - The Helm values file, listing EraSearch's configuration options in YAML. Era Software customizes the file to your environment.

To customize EraSearch, edit the configuration options in the values file and specify that file when deploying EraSearch. The values file overrides the default configuration options in the Helm charts.

For EraSearch on EraCloud
Copy
Copied!

Era Software configures and manages EraSearch on EraCloud for you. You don't need to configure or customize your EraSearch instance, and it's ready for production by default.

Using values files
Copy
Copied!

To configure self-hosted EraSearch, edit the options in values-eradb.yaml. Then specify the file in the helm install or helm upgrade commands. To view the configuration options for an existing release, use helm get values.

Note: You can also override default configuration options by setting specific values in the helm install and helm upgrade commands. Visit Helm's install and upgrade documentation for more information.

helm install example
Copy
Copied!

The command below installs EraSearch into a Kubernetes cluster.

The command installs the eradb-1.2.3.tgz charts into the logs-erasearch namespace. Helm uses the configurations in values-eradb.yaml to override default chart values, and the release is called myerasearch.

Copy
Copied!
$ helm install myerasearch ./eradb-1.2.3.tgz \
    --values ./values-eradb.yaml \ 
    --namespace logs-erasearch

The install command returns this output:

Copy
Copied!
deployment "myerasearch-quarry-deployment" successfully rolled out

helm upgrade example
Copy
Copied!

The command below upgrades an existing EraSearch release in a Kubernetes cluster.

The command upgrades the myerasearch release in the logs-erasearch namespace. Helm applies the updated eradb-1.2.3.tgz charts and values-eradb.yaml file to the existing release.

Copy
Copied!
$ helm upgrade myerasearch ./eradb-1.2.3.tgz \
    --values ./values-eradb.yaml \ 
    --namespace logs-erasearch

The upgrade command returns this output along with other deployment details:

Copy
Copied!
Release myerasearch-quarry-deployment has been upgraded. Happy Helming!

helm get values example
Copy
Copied!

This command displays the configuration options used in an EraSearch release (myerasearch):

Copy
Copied!
$ helm get values myerasearch

The command returns USER-SUPPLIED VALUES followed by the configuration options. The response is organized by service and lists the options in alphabetical order.