Getting Started

Installation

Be sure to take a look at the requirements before installing the operator. Helm Add the m3db-operator repo: helm repo add m3db https://m3-helm-charts.storage.googleapis.com/stable Install the m3db-operator chart: helm install m3db-operator m3db/m3db-operator Note: If uninstalling an instance of the operator that was installed with Helm, some resources such as the ClusterRole, ClusterRoleBinding, and ServiceAccount may need to be deleted manually. Manually Install the bundled operator manifests in the current namespace:

Updating a Cluster

After your cluster has been running for some time you may decide you want to change the cluster’s spec. For instance, you may want to upgrade to a newer release of M3DB or modify the cluster’s config file. The operator can be used to safely rollout such changes so you don’t need to do anything other than add an annotation to enable updates. The first step in updating a cluster is to update the cluster’s M3DBCluster CRD with the changes you want to make.

Monitoring

M3DB exposes metrics via a Prometheus endpoint. If using the Prometheus Operator, you can apply a ServiceMonitor to have your M3DB pods automatically scraped by Prometheus: kubectl apply -f You can visit the “targets” page of the Prometheus UI to verify the pods are being scraped. To view these metrics using Grafana, follow the M3 docs to install the M3DB Grafana dashboard.