Back to Charts

⚠️ Repo Archive Notice

stable/elasticsearch-curator/README.md

latest7.0 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

Elasticsearch Curator Helm Chart

This directory contains a Kubernetes chart to deploy the Elasticsearch Curator.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

Prerequisites Details

  • Elasticsearch

  • The elasticsearch-curator cron job requires K8s CronJob support:

    You need a working Kubernetes cluster at version >= 1.8 (for CronJob). For previous versions of cluster (< 1.8) you need to explicitly enable batch/v2alpha1 API by passing --runtime-config=batch/v2alpha1=true to the API server (see Turn on or off an API version for your cluster for more).

Chart Details

This chart will do the following:

  • Create a CronJob which runs the Curator

Installing the Chart

To install the chart, use the following:

console
$ helm install stable/elasticsearch-curator

Upgrading an existing Release to a new major version

A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions.

To 2.0.0

v2.0.0 uses docker image from elasticsearch-curator author, which differs in its way to install curator.

If you have a hardcoded command value, please update it to follow the new curator executable path: /curator/curator (which is not in PATH).

Configuration

The following table lists the configurable parameters of the docker-registry chart and their default values.

ParameterDescriptionDefault
image.pullPolicyContainer pull policyIfNotPresent
image.repositoryContainer image to useuntergeek/curator
image.tagContainer image tag to deploy5.7.6
hooksWhether to run job on selected hooks{ "install": false, "upgrade": false }
cronjob.scheduleSchedule for the CronJob0 1 * * *
cronjob.annotationsAnnotations to add to the cronjob{}
cronjob.labelsLabels to add to the cronjob{}
cronjob.concurrencyPolicyAllow|Forbid|Replace concurrent jobsnil
cronjob.failedJobsHistoryLimitSpecify the number of failed Jobs to keepnil
cronjob.successfulJobsHistoryLimitSpecify the number of completed Jobs to keepnil
cronjob.jobRestartPolicyControl the Job restartPolicyNever
cronjob.startingDeadlineSecondsAmount of time to try reschedule job if we can't run on timenil
pod.annotationsAnnotations to add to the pod{}
pod.labelsLabels to add to the pod{}
dryrunRun Curator in dry-run modefalse
envEnvironment variables to add to the cronjob container{}
envFromSecretsEnvironment variables from secrets to the cronjob container{}
envFromSecrets.*.from.secret- secretKeyRef.name used for environment variable
envFromSecrets.*.from.key- secretKeyRef.key used for environment variable
commandCommand to execute["/curator/curator"]
configMaps.action_file_ymlContents of the Curator action_file.ymlSee values.yaml
configMaps.config_ymlContents of the Curator config.yml (overrides config)See values.yaml
resourcesResource requests and limits{}
priorityClassNamepriorityClassNamenil
extraVolumeMountsMount extra volume(s),
extraVolumesExtra volumes
extraInitContainersInit containers to add to the cronjob container{}
securityContextConfigure PodSecurityContextfalse
rbac.enabledEnable RBAC resourcesfalse
psp.createCreate pod security policy resourcesfalse
serviceAccount.createCreate a default serviceaccount for elasticsearch curatortrue
serviceAccount.nameName for elasticsearch curator serviceaccount""

Specify each parameter using the --set key=value[,key=value] argument to helm install.