v1alpha1

type ClusterCondition struct {
	// Type of cluster condition.
	Type ClusterConditionType `json:"type,omitempty"`

	// Status of the condition (True, False, Unknown).
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time this condition was updated.
	LastUpdateTime string `json:"lastUpdateTime,omitempty"`

	// Last time this condition transitioned from one status to another.
	LastTransitionTime string `json:"lastTransitionTime,omitempty"`

	// Reason this condition last changed.
	Reason string `json:"reason,omitempty"`

	// Human-friendly message about this condition.
	Message string `json:"message,omitempty"`
}

type ClusterConditionType string

type ClusterSpec struct {
	// Image specifies which docker image to use with the cluster
	Image string `json:"image,omitempty"`

	// ReplicationFactor defines how many replicas
	ReplicationFactor int32 `json:"replicationFactor,omitempty"`

	// NumberOfShards defines how many shards in total
	NumberOfShards int32 `json:"numberOfShards,omitempty"`

	// IsolationGroups specifies a map of key-value pairs. Defines which isolation groups
	// to deploy persistent volumes for data nodes
	IsolationGroups []IsolationGroup `json:"isolationGroups,omitempty"`

	// Namespaces specifies the namespaces this cluster will hold.
	Namespaces []Namespace `json:"namespaces,omitempty"`

	// EtcdEndpoints defines the etcd endpoints to use for service discovery. Must
	// be set if no custom configmap is defined. If set, etcd endpoints will be
	// templated in to the default configmap template.
	// +optional
	EtcdEndpoints []string `json:"etcdEndpoints,omitempty"`

	// KeepEtcdDataOnDelete determines whether the operator will remove cluster
	// metadata (placement + namespaces) in etcd when the cluster is deleted.
	// Unless true, etcd data will be cleared when the cluster is deleted.
	// +optional
	KeepEtcdDataOnDelete bool `json:"keepEtcdDataOnDelete,omitempty"`

	// EnableCarbonIngester enables the listener port for the carbon ingester
	// +optional
	EnableCarbonIngester bool `json:"enableCarbonIngester,omitempty"`

	// ConfigMapName specifies the ConfigMap to use for this cluster. If unset a
	// default configmap with template variables for etcd endpoints will be used.
	// See "Configuring M3DB" in the docs for more.
	// +optional
	ConfigMapName *string `json:"configMapName,omitempty"`

	// PodIdentityConfig sets the configuration for pod identity. If unset only
	// pod name and UID will be used.
	// +optional
	PodIdentityConfig *PodIdentityConfig `json:"podIdentityConfig,omitempty"`

	// Resources defines memory / cpu constraints for each container in the
	// cluster.
	// +optional
	ContainerResources corev1.ResourceRequirements `json:"containerResources,omitempty"`

	// DataDirVolumeClaimTemplate is the volume claim template for an M3DB
	// instance's data. It claims PersistentVolumes for cluster storage, volumes
	// are dynamically provisioned by when the StorageClass is defined.
	// +optional
	DataDirVolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"dataDirVolumeClaimTemplate,omitempty"`

	// PodSecurityContext allows the user to specify an optional security context
	// for pods.
	PodSecurityContext *corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`

	// SecurityContext allows the user to specify a container-level security
	// context.
	SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`

	// ImagePullSecrets will be added to every pod.
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`

	// EnvVars defines custom environment variables to be passed to M3DB
	// containers.
	//
	// +optional
	EnvVars []corev1.EnvVar `json:"envVars,omitempty"`

	// Labels sets the base labels that will be applied to resources created by
	// the cluster. // TODO(schallert): design doc on labeling scheme.
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations sets the base annotations that will be applied to resources created by
	// the cluster.
	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations"`

	// Tolerations sets the tolerations that will be applied to all M3DB pods.
	// +optional
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

	// PriorityClassName sets the priority class for all M3DB pods.
	// +optional
	PriorityClassName string `json:"priorityClassName,omitempty"`

	// NodeEndpointFormat allows overriding of the endpoint used for a node in the
	// M3DB placement. Defaults to "{{ .PodName }}.{{ .M3DBService }}:{{ .Port }}".
	// Useful if access to the cluster from other namespaces is desired. See "Node
	// Endpoint" docs for full variables available.
	// +optional
	NodeEndpointFormat string `json:"nodeEndpointFormat,omitempty"`

	// HostNetwork indicates whether M3DB pods should run in the same network
	// namespace as the node its on. This option should be used sparingly due to
	// security concerns outlined in the linked documentation.
	// https://kubernetes.io/docs/concepts/policy/pod-security-policy/#host-namespaces
	// +optional
	HostNetwork bool `json:"hostNetwork,omitEmpty"`

	// DNSPolicy allows the user to set the pod's DNSPolicy. This is often used in
	// conjunction with HostNetwork.+optional
	// +optional
	DNSPolicy *corev1.DNSPolicy `json:"dnsPolicy,omitEmpty"`

	// Specify a "controlling" coordinator for the cluster.
	ExternalCoordinator *ExternalCoordinatorConfig `json:"externalCoordinator,omitempty"`

	// Custom setup for db nodes can be done via initContainers
	// Provide the complete spec for the initContainer here
	// If any storage volumes are needed in the initContainer see InitVolumes below
	InitContainers []corev1.Container `json:"initContainers,omitempty"`

	// If the InitContainers require any storage volumes
	// Provide the complete specification for the required Volumes here
	InitVolumes []corev1.Volume `json:"initVolumes,omitempty"`

	// PodMetadata is for any Metadata that is unique to the pods, and does
	// not belong on any other objects, such as Prometheus scrape tags
	PodMetadata metav1.ObjectMeta `json:"podMetadata,omitempty"`

	// ParallelPodManagement sets StatefulSets created by the operator to have
	// Parallel pod management instead of OrderedReady. This is an EXPERIMENTAL
	// flag and subject to deprecation in a future release. This has not been
	// tested in production and users should not depend on it without validating
	// it for their own use case.
	ParallelPodManagement bool `json:"parallelPodManagement,omitEmpty"`
}

type ExternalCoordinatorConfig struct {
	Selector map[string]string `json:"selector,omityempty"`
}

type IndexOptions struct {
	// Enabled controls whether metric indexing is enabled.
	Enabled bool `json:"enabled,omitempty"`

	// BlockSize controls the index block size.
	BlockSize string `json:"blockSize,omitempty"`
}

type IsolationGroup struct {
	// Name is the value that will be used in StatefulSet labels, pod labels, and
	// M3DB placement "isolationGroup" fields.
	Name string `json:"name"`

	// NodeAffinityTerms is an array of NodeAffinityTerm requirements, which are
	// ANDed together to indicate what nodes an isolation group can be assigned
	// to.
	NodeAffinityTerms []NodeAffinityTerm `json:"nodeAffinityTerms,omitempty"`

	// NumInstances defines the number of instances.
	NumInstances int32 `json:"numInstances"`

	// StorageClassName is the name of the StorageClass to use for this isolation
	// group. This allows ensuring that PVs will be created in the same zone as
	// the pinned statefulset on Kubernetes < 1.12 (when topology aware volume
	// scheduling was introduced). Only has effect if the clusters
	// `dataDirVolumeClaimTemplate` is non-nil. If set, the volume claim template
	// will have its storageClassName field overridden per-isolationgroup. If
	// unset the storageClassName of the volumeClaimTemplate will be used.
	// +optional
	StorageClassName string `json:"storageClassName,omitempty"`
}

type IsolationGroups []IsolationGroup

type M3DBCluster struct {
	metav1.TypeMeta `json:",inline"`
	// +k8s:openapi-gen=false
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Type              string      `json:"type"`
	Spec              ClusterSpec `json:"spec"`
	Status            M3DBStatus  `json:"status,omitempty"`
}

type M3DBClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []M3DBCluster `json:"items"`
}

type M3DBState string

type M3DBStatus struct {
	// State is a enum of green, yellow, and red denoting the health of the
	// cluster
	State M3DBState `json:"state,omitempty"`

	// Various conditions about the cluster.
	Conditions []ClusterCondition `json:"conditions,omitempty"`

	// Message is a human readable message indicating why the cluster is in it's
	// current state
	Message string `json:"message,omitempty"`

	// ObservedGeneration is the last generation of the cluster the controller
	// observed. Kubernetes will automatically increment metadata.Generation every
	// time the cluster spec is changed.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

type Namespace struct {
	// Name is the namespace name.
	Name string `json:"name,omitempty"`

	// Preset indicates preset namespace options.
	Preset string `json:"preset,omitempty"`

	// Options points to optional custom namespace configuration.
	// +optional
	Options *NamespaceOptions `json:"options,omitempty"`
}

type NamespaceOptions struct {
	// BootstrapEnabled control if bootstrapping is enabled.
	BootstrapEnabled bool `json:"bootstrapEnabled,omitempty"`

	// FlushEnabled controls whether flushing is enabled.
	FlushEnabled bool `json:"flushEnabled,omitempty"`

	// WritesToCommitLog controls whether commit log writes are enabled.
	WritesToCommitLog bool `json:"writesToCommitLog,omitempty"`

	// CleanupEnabled controls whether cleanups are enabled.
	CleanupEnabled bool `json:"cleanupEnabled,omitempty"`

	// RepairEnabled controls whether repairs are enabled.
	RepairEnabled bool `json:"repairEnabled,omitempty"`

	// SnapshotEnabled controls whether snapshotting is enabled.
	SnapshotEnabled bool `json:"snapshotEnabled,omitempty"`

	// RetentionOptions sets the retention parameters.
	RetentionOptions RetentionOptions `json:"retentionOptions,omitempty"`

	// IndexOptions sets the indexing parameters.
	IndexOptions IndexOptions `json:"indexOptions,omitempty"`
}

type NodeAffinityTerm struct {
	// Key is the label of the node.
	Key string `json:"key"`

	// Values is an array of values, any of which a node can have for a pod to be
	// assigned to it.
	Values []string `json:"values"`
}

type PodIdentity struct {
	Name           string `json:"name,omitempty"`
	UID            string `json:"uid,omitempty"`
	NodeName       string `json:"nodeName,omitempty"`
	NodeExternalID string `json:"nodeExternalID,omitempty"`
	NodeProviderID string `json:"nodeProviderID,omitempty"`
}

type PodIdentityConfig struct {
	// Sources enumerates the sources from which to derive pod identity. Note that
	// a pod's name will always be used. If empty, defaults to pod name and
	// UID.
	Sources []PodIdentitySource `json:"sources"`
}

type PodIdentitySource string

type RetentionOptions struct {
	// RetentionPeriod controls how long data for the namespace is retained.
	RetentionPeriod string `json:"retentionPeriod,omitempty"`

	// BlockSize controls the block size for the namespace.
	BlockSize string `json:"blockSize,omitempty"`

	// BufferFuture controls how far in the future metrics can be written.
	BufferFuture string `json:"bufferFuture,omitempty"`

	// BufferPast controls how far in the past metrics can be written.
	BufferPast string `json:"bufferPast,omitempty"`

	// BlockDataExpiry controls the block expiry.
	BlockDataExpiry bool `json:"blockDataExpiry,omitempty"`

	// BlockDataExpiry controls the not after access period for expiration.
	BlockDataExpiryAfterNotAccessPeriod string `json:"blockDataExpiryAfterNotAccessPeriod,omitempty"`
}