Kubernetes Operator

This documentation is for the M3DB Kubernetes operator which can run and operate M3DB on Kubernetes. For more background on the M3DB operator, see our KubeCon keynote on its origins and usage at Uber. Philosophy The M3DB operator aims to automate everyday tasks around managing M3DB. Specifically, it aims to automate: Creating M3DB clusters Destroying M3DB clusters Expanding clusters (adding instances) Shrinking clusters (removing instances) Replacing failed instances It explicitly does not try to automate every single edge case a user may ever run into.

This document enumerates the Custom Resource Definitions used by the M3DB Operator. It is auto-generated from code comments. Table of Contents Table of Contents ClusterCondition ClusterSpec ExternalCoordinatorConfig IsolationGroup M3DBCluster M3DBClusterList M3DBStatus NodeAffinityTerm AggregatedAttributes Aggregation AggregationOptions DownsampleOptions IndexOptions Namespace NamespaceOptions RetentionOptions PodIdentity PodIdentityConfig ClusterCondition ClusterCondition represents various conditions the cluster can be in. Field Description Scheme Required type Type of cluster condition. ClusterConditionType false status Status of the condition (True, False, Unknown).