crate-operator
crate-operator copied to clipboard
The CrateDB Kubernetes Operator provides a convenient way to run CrateDB clusters inside Kubernetes.
.. image:: https://github.com/crate/crate-operator/workflows/CI/badge.svg :alt: Continuous Integration :target: https://github.com/crate/crate-operator
.. image:: https://github.com/crate/crate-operator/workflows/Build%20and%20publish%20Docker%20Image/badge.svg :alt: Docker Build :target: https://github.com/crate/crate-operator
.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg :alt: Documentation :target: https://crate-operator.readthedocs.io/en/latest/
.. image:: https://img.shields.io/badge/container-docker-green.svg :alt: Docker Hub :target: https://hub.docker.com/crate/crate-operator/
============================= โ๏ธ CrateDB Kubernetes Operator
The CrateDB Kubernetes Operator provides convenient way to run CrateDB
_
clusters inside Kubernetes
. It is built on top of the Kopf: Kubernetes Operators Framework
.
๐๏ธ Contents
-
๐คน Usage
_ -
๐ Features
_ -
๐ฝ Installation
_ -
๐ป Development
_
๐คน Usage
A minimal custom resource for a 3 node CrateDB cluster may look like this:
dev-cluster.yaml
:
.. code-block:: yaml
apiVersion: cloud.crate.io/v1 kind: CrateDB metadata: name: my-cluster namespace: dev spec: cluster: imageRegistry: crate name: crate-dev version: 5.2.5 nodes: data: - name: hot replicas: 3 resources: limits: cpu: 4 memory: 4Gi disk: count: 1 size: 128GiB storageClass: default heapRatio: 0.5
.. code-block:: console
$ kubectl --namespace dev create -f dev-cluster.yaml ...
$ kubectl --namespace dev get cratedbs NAMESPACE NAME AGE dev my-cluster 36s
Please note that the minimum version of CrateDB that the operator supports is 4.5. Previous versions might work, but the operator will not attempt to set a license.
๐ Features
- "all equal nodes" cluster setup
- "master + data nodes" cluster setup
- safe scaling of clusters
- safe rolling version upgrades for clusters
- SSL for HTTP and PG connections via Let's Encrypt certificate
- custom node settings
- custom cluster settings
- custom storage classes
- region/zone awareness for AWS and Azure
๐ฝ Installation
Installation with Helm
To be able to deploy the custom resource CrateDB
to a Kubernetes cluster,
the API needs to be extended with a Custom Resource Definition
(CRD).
It can be installed separately by installing the CRD Helm Chart
_ or as a
dependency of the Operator Helm Chart
_.
.. code-block:: console
helm repo add crate-operator https://crate.github.io/crate-operator helm install crate-operator crate-operator/crate-operator
To override the environment variables from values.yaml, please refer to
the configuration documentation
_.
Installation with kubectl
To be able to deploy the custom resource CrateDB
to a Kubernetes cluster,
the API needs to be extended with a Custom Resource Definition
(CRD). The CRD
for CrateDB
can be found in the deploy/
folder and can be applied
(assuming sufficient privileges).
.. code-block:: console
$ kubectl apply -f deploy/crd.yaml customresourcedefinition.apiextensions.k8s.io/cratedbs.cloud.crate.io created
Once the CRD is installed, the operator itself can be deployed using a
Deployment
in the crate-operator
namespace.
.. code-block:: console
$ kubectl create namespace crate-operator ... $ kubectl create -f deploy/rbac.yaml ... $ kubectl create -f deploy/deployment.yaml ...
Please refer to the configuration documentation
_ for further details.
๐ป Development
Please refer to the Working on the operator
_ section of the documentation.
.. _CrateDB: https://github.com/crate/crate
.. _Custom Resource Definition: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
.. _Kubernetes: https://kubernetes.io/
.. _Kopf: Kubernetes Operators Framework
: https://kopf.readthedocs.io/en/latest/
.. _configuration documentation: ./docs/source/configuration.rst
.. _Working on the operator: ./docs/source/development.rst
.. _CRD Helm Chart: ./deploy/charts/crate-operator-crds/README.md
.. _Operator Helm Chart: ./deploy/charts/crate-operator/README.md