types.go

package v1alpha1

import (
	"k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// ElasticsearchList struct represents list of Elasticsearch objects
type ElasticsearchList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Elasticsearch `json:"items"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// Elasticsearch struct represents Elasticsearch cluster CRD
type Elasticsearch struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	Spec              ElasticsearchSpec   `json:"spec"`
	Status            ElasticsearchStatus `json:"status,omitempty"`
}

// ElasticsearchNode struct represents individual node in Elasticsearch cluster
type ElasticsearchNode struct {
	Roles        []ElasticsearchNodeRole        `json:"roles"`
	Replicas     int32                          `json:"replicas"`
	Spec         ElasticsearchNodeSpec          `json:"nodeSpec"`
	NodeSelector map[string]string              `json:"nodeSelector,omitempty"`
	Storage      ElasticsearchNodeStorageSource `json:"storage"`
}

type ElasticsearchNodeStorageSource struct {
	// HostPath option will mount directory from the host.
	// Cluster administrator must grant `hostaccess` scc to the service account.
	// Cluster admin also must set appropriate SELINUX labels and perissions
	// for the directory on the host.
	HostPath *v1.HostPathVolumeSource `json:"hostPath,omitempty"`

	// EmptyDir should be only used for testing purposes and not in production.
	// This option will use temporary directory for data storage. Data will be lost
	// when Pod is regenerated.
	EmptyDir *v1.EmptyDirVolumeSource `json:"emptyDir,omitempty"`

	// VolumeClaimTemplate is supposed to act similarly to VolumeClaimTemplates field
	// of StatefulSetSpec. Meaning that it'll generate a number of PersistentVolumeClaims
	// per individual Elasticsearch cluster node. The actual PVC name used will
	// be constructed from VolumeClaimTemplate name, node type and replica number
	// for the specific node.
	VolumeClaimTemplate *v1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`

	// PersistentVolumeClaim will NOT try to regenerate PVC, it will be used
	// as-is. You may want to use it instead of VolumeClaimTemplate in case
	// you already have bounded PersistentVolumeClaims you want to use, and the names
	// of these PersistentVolumeClaims doesn't follow the naming convention.
	PersistentVolumeClaim *v1.PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty"`
}

// ElasticsearchNodeStatus represents the status of individual Elasticsearch node
type ElasticsearchNodeStatus struct {
	DeploymentName  string `json:"deploymentName,omitempty"`
	ReplicaSetName  string `json:"replicaSetName,omitempty"`
	StatefulSetName string `json:"statefulSetName,omitempty"`
	PodName         string `json:"podName,omitempty"`
	Status          string `json:"status,omitempty"`
}

// ElasticsearchSpec struct represents the Spec of Elasticsearch cluster CRD
type ElasticsearchSpec struct {
	// Fill me
	Nodes              []ElasticsearchNode   `json:"nodes"`
	Spec               ElasticsearchNodeSpec `json:"nodeSpec"`
	Secure             ElasticsearchSecure   `json:"securityConfig"`
	ServiceAccountName string                `json:"serviceAccountName,omitempty"`
	ConfigMapName      string                `json:"configMapName,omitempty"`
}

// ElasticsearchNodeSpec represents configuration of an individual Elasticsearch node
type ElasticsearchNodeSpec struct {
	Image     string                  `json:"image,omitempty"`
	Resources v1.ResourceRequirements `json:"resources"`
}

// ElasticsearchSecure struct represents security configuration of the cluster
// whether SearchGuard is enabled along with oauth-proxy sidecar
type ElasticsearchSecure struct {
	Disabled           bool   `json:"disabled"`
	Image              string `json:"image,omitempty"`
	CertificatesSecret string `json:"certificatesSecret,omitempty"`
}

type ElasticsearchRequiredAction string

const (
	ElasticsearchActionRollingRestartNeeded ElasticsearchRequiredAction = "RollingRestartNeeded"
	ElasticsearchActionFullRestartNeeded    ElasticsearchRequiredAction = "FullRestartNeeded"
	ElasticsearchActionInterventionNeeded   ElasticsearchRequiredAction = "InterventionNeeded"
	ElasticsearchActionNewClusterNeeded     ElasticsearchRequiredAction = "NewClusterNeeded"
	ElasticsearchActionNone                 ElasticsearchRequiredAction = "ClusterOK"
	ElasticsearchActionScaleDownNeeded      ElasticsearchRequiredAction = "ScaleDownNeeded"
	ElasticsearchActionStatusUpdateNeeded   ElasticsearchRequiredAction = "StatusUpdateNeeded"
)

type ElasticsearchNodeRole string

const (
	ElasticsearchRoleClient ElasticsearchNodeRole = "client"
	ElasticsearchRoleData   ElasticsearchNodeRole = "data"
	ElasticsearchRoleMaster ElasticsearchNodeRole = "master"
)

// ElasticsearchStatus represents the status of Elasticsearch cluster
type ElasticsearchStatus struct {
	// Fill me
	Nodes    []ElasticsearchNodeStatus   `json:"nodes"`
	K8sState ElasticsearchRequiredAction `json:"clusterState"`
}