https://github.com/xco-sk/eck-custom-resources
Kubernetes operator for Indices, Index Templates, Roles, Users and other Elasticsearch and Kibana related resources.
https://github.com/xco-sk/eck-custom-resources
elasticsearch go helm kibana kubernetes kubernetes-operator operator
Last synced: 3 months ago
JSON representation
Kubernetes operator for Indices, Index Templates, Roles, Users and other Elasticsearch and Kibana related resources.
- Host: GitHub
- URL: https://github.com/xco-sk/eck-custom-resources
- Owner: xco-sk
- License: apache-2.0
- Created: 2022-03-06T12:14:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-21T17:51:15.000Z (3 months ago)
- Last Synced: 2026-03-22T06:05:43.291Z (3 months ago)
- Topics: elasticsearch, go, helm, kibana, kubernetes, kubernetes-operator, operator
- Language: Go
- Homepage:
- Size: 21.6 MB
- Stars: 38
- Watchers: 3
- Forks: 12
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Custom resources for ECK
[](https://github.com/xco-sk/eck-custom-resources/actions/workflows/docker-publish.yaml)
[](https://github.com/xco-sk/eck-custom-resources/actions/workflows/helm-publish.yml)
Kubernetes operator that enables the installation of various resources for
Elasticsearch and Kibana.
Currently supported resources:
- For Elasticsearch:
- [Elasticsearch Instance](docs/cr_elasticsearch_instance.md)
- [Index](docs/cr_index.md)
- [Index template](docs/cr_index_template.md)
- [Index lifecycle policy](docs/cr_index_lifecycle_policy.md)
- [Ingest pipeline](docs/cr_ingest_pipeline.md)
- [Snapshot repository](docs/cr_snapshot_repo.md)
- [Snapshot lifecycle policy](docs/cr_snapshot_lifecycle_policy.md)
- [User](docs/cr_user.md)
- [Role](docs/cr_role.md)
- [API key](docs/cr_apikey.md)
- [Component template](docs/cr_component_template.md)
- For Kibana:
- [Kibana Instance](docs/cr_kibana_instance.md)
- [Space](docs/cr_space.md)
- [Index pattern](docs/cr_index_pattern.md)
- [Saved search](docs/cr_saved_search.md)
- [Visualization](docs/cr_visualization.md)
- [Lens](docs/cr_lens.md)
- [Dashboard](docs/cr_dashboard.md)
- [Data View](docs/cr_data_view.md)
## Installation
```shell
# Add eck-custom-resources helm repo
helm repo add eck-custom-resources https://xco-sk.github.io/eck-custom-resources/
# Install chart
helm install eck-cr eck-custom-resources/eck-custom-resources-operator
```
Configuration options are documented in [chart README file](charts/eck-custom-resources-operator/README.md)
## Upgrade guide
### From 0.7.0 to 0.7.1
Existing `ComponentTemplate` CRD was fixed. To apply the CRD, run:
```
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/v0.7.1/config/crd/bases/es.eck.github.com_componenttemplates.yaml
```
### From 0.6.0 to 0.7.0
There is a new `ComponentTemplate` CRD present. To apply the CRD, run:
```
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/v0.7.0/config/crd/bases/es.eck.github.com_componenttemplates.yaml
```
### From 0.5.0 to 0.6.0
The Elasticsearch API Key support was introduced. To apply the CRD, run:
```
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/v0.6.0/config/crd/bases/es.eck.github.com_elasticsearchapikeys.yaml
```
### From 0.4.1 to 0.5.0
The Multi-target support was introduced. This changes is backward compatible, but in order to make use of the multi-target support
apply the new CRDs manually:
```
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_elasticsearchinstances.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_elasticsearchroles.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_elasticsearchusers.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_indexlifecyclepolicies.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_indextemplates.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_indices.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_ingestpipelines.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_snapshotlifecyclepolicies.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/es.eck.github.com_snapshotrepositories.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_kibanainstances.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_dashboards.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_indexpatterns.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_lens.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_savedsearches.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_spaces.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_visualizations.yaml
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.5.0/config/crd/bases/kibana.eck.github.com_dataviews.yaml
```
There are 2 new CRDs, `ElasticsearchInstance` and `KibanaInstance` that allows you to deploy the target configuration for
both Kibana and Elasticsearch. The rest of the CRDs were extended with optional `spec.targetInstance.name` field, that should reference
the `ElasticsearchInstance`/`KibanaInstance`. If `targetInstance` field is not present, the default operator configuration (`elasticsearch` and `kibana`
fields) is used.
This approach should ensure the backward compatibility with previously deployed CRDs.
See [samples](config/samples).
### From 0.3.2 to 0.4.1
There is new `DataView` CRD present. To apply the CRD, run:
```
kubectl apply --server-side -f https://raw.githubusercontent.com/xco-sk/eck-custom-resources/eck-custom-resources-operator-0.4.1/config/crd/bases/kibana.eck.github.com_dataviews.yaml
```
## Uninstallation
To uninstall the eck-cr from Kubernetes cluster, run:
```shell
helm uninstall eck-cr
```
This removes all resources related to eck-custom-resources operator. It won't remove the CRDs nor any deployed custom resource
(e.g. Index, Index Template ...), they will remain in K8s and also in Elasticsearch.
## Working with custom resources
After the operator is installed, you can deploy Elasticsearch/Kibana resources from the list above. The reconciler
will take care of propagating the change to Elasticsearch or Kibana, whether it is creation of new resource, deletion
or update. Definition of target Elasticsearch/Kibana is done using [Elasticsearch Instance](docs/cr_elasticsearch_instance.md) and
[Kibana Instance](docs/cr_kibana_instance.md) resources. These are then referenced (by name) from other resources through `spec.targetInstance.name` field.
For detailed documentation for each resource, see [List of supported resources](docs/cr_list.md)
## Help and Troubleshooting
In case you need help or found a bug, please create an [Issue on Github](https://github.com/xco-sk/eck-custom-resources/issues).
## License
Licensed under the Apache License, Version 2.0; see [LICENSE.md](LICENSE.md)