/chart-curator

Primary LanguageSmartyApache License 2.0Apache-2.0

Chart for Curator

Build Status

Elasticsearch Curator helps you curate, or manage, your Elasticsearch indices by:

  • Obtaining the full list of indices from the cluster, as the actionable list
  • Iterating through a list of user-defined filters to progressively remove indices from the actionable list as needed.

Our Chart deletes all logstash-prefixed indices older than 14 days.

Installation

From our chart repository

helm repo add cnct https://charts.migrations.cnct.io
helm repo update
helm install cnct/curator 

To install from local repository

helm install --name my-release --namespace my-namespace ./curator

To install from local, overriding the base image and tag directly:

helm install --name my-release --namespace my-namespace \
  --set image.name=bobrik/curator \
  --set image.tag=5.2.0 \
  ./curator

To install from local, overriding with a values file:

helm install --name my-release --namespace my-namespace \
  --values ./staging-values.yaml \
  ./curator

In which the file ./staging-values.yaml contains:

image:
  name: bobrik/curator
  tag: 5.2.0

# sets the cron job to execute everyday at 2am
schedule: "00 2 * * *"

description:
  Delete indices older than 7 days and prefixed with logstash-.

filters:
- filtertype: pattern
  kind: prefix
  value: "logstash-"
  exclude: False
- filtertype: age
  source: name
  timestring: '%Y.%m.%d'
  direction: older
  unit: days
  unit_count: 7
  field: null
  stats_result: null
  epoch: null
  exclude: False

Configuration

The following tables lists the configurable parameters of the Curator chart and their default values.

Parameter Description Default
name Name of the chart curator
image.name FQDN repository/image name quay.io/samsung_cnct/curator-container
image.tag Image tag latest
schedule The cron schedule 30 3 * * *
action Name of the action delete_indices
description Description of the action <see values.yaml>
options Options of the action <see values.yaml>
filters Filters of the action <see values.yaml>
client Client configuration <see values.yaml>
logging Loging configuration <see values.yaml>

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

References

Credit

Created and maintained by the Samsung Cloud Native Computing Team.