[Stack Monitoring] Elasticsearch monitoring with Metricbeat and Filebeat as sidecars

cmd/manager/main.go

@@ -677,7 +677,7 @@ func registerControllers(mgr manager.Manager, params operator.Parameters, access
 		{name: "BEAT-KB", registerFunc: associationctl.AddBeatKibana},
 		{name: "AGENT-ES", registerFunc: associationctl.AddAgentES},
 		{name: "EMS-ES", registerFunc: associationctl.AddMapsES},
-		{name: "ES-ES", registerFunc: associationctl.AddEsEs},
+		{name: "ES-MONITORING", registerFunc: associationctl.AddEsMonitoring},
 	}
 
 	for _, c := range assocControllers {

config/crds/all-crds.yaml

@@ -2167,9 +2167,9 @@ spec:
               description: Image is the Elasticsearch Docker image to deploy.
               type: string
             monitoring:
-              description: Monitoring enables you to extract log and stack monitoring
+              description: Monitoring enables you to extract log and Stack Monitoring
                 metrics of this Elasticsearch cluster. Metricbeat and Filebeat are
-                deployed in the same pod as sidecar and each one send data to one
+                deployed in the same Pod as sidecars and each one send data to one
                 or two different monitoring Elasticsearch clusters running in the
                 same Kubernetes cluster.
               properties:
@@ -2203,7 +2203,7 @@ spec:
                     elasticsearchRef:
                       description: ElasticsearchRef is a reference to a monitoring
                         Elasticsearch cluster running in the same Kubernetes cluster
-                        dedicated to receiving stack monitoring metrics.
+                        dedicated to receiving Stack Monitoring metrics.
                       properties:
                         name:
                           description: Name of the Kubernetes object.

config/crds/bases/elasticsearch.k8s.elastic.co_elasticsearches.yaml

@@ -243,7 +243,7 @@ spec:
                 description: Image is the Elasticsearch Docker image to deploy.
                 type: string
               monitoring:
-                description: Monitoring enables you to extract log and stack monitoring metrics of this Elasticsearch cluster. Metricbeat and Filebeat are deployed in the same pod as sidecar and each one send data to one or two different monitoring Elasticsearch clusters running in the same Kubernetes cluster.
+                description: Monitoring enables you to extract log and Stack Monitoring metrics of this Elasticsearch cluster. Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one send data to one or two different monitoring Elasticsearch clusters running in the same Kubernetes cluster.
                 properties:
                   logs:
                     properties:
@@ -266,7 +266,7 @@ spec:
                   metrics:
                     properties:
                       elasticsearchRef:
-                        description: ElasticsearchRef is a reference to a monitoring Elasticsearch cluster running in the same Kubernetes cluster dedicated to receiving stack monitoring metrics.
+                        description: ElasticsearchRef is a reference to a monitoring Elasticsearch cluster running in the same Kubernetes cluster dedicated to receiving Stack Monitoring metrics.
                         properties:
                           name:
                             description: Name of the Kubernetes object.

deploy/eck-operator/charts/eck-operator-crds/templates/all-crds.yaml

@@ -2197,9 +2197,9 @@ spec:
               description: Image is the Elasticsearch Docker image to deploy.
               type: string
             monitoring:
-              description: Monitoring enables you to extract log and stack monitoring
+              description: Monitoring enables you to extract log and Stack Monitoring
                 metrics of this Elasticsearch cluster. Metricbeat and Filebeat are
-                deployed in the same pod as sidecar and each one send data to one
+                deployed in the same Pod as sidecars and each one send data to one
                 or two different monitoring Elasticsearch clusters running in the
                 same Kubernetes cluster.
               properties:
@@ -2233,7 +2233,7 @@ spec:
                     elasticsearchRef:
                       description: ElasticsearchRef is a reference to a monitoring
                         Elasticsearch cluster running in the same Kubernetes cluster
-                        dedicated to receiving stack monitoring metrics.
+                        dedicated to receiving Stack Monitoring metrics.
                       properties:
                         name:
                           description: Name of the Kubernetes object.

docs/reference/api-docs.asciidoc

@@ -904,7 +904,7 @@ ElasticsearchSpec holds the specification of an Elasticsearch cluster.
 | *`serviceAccountName`* __string__ | ServiceAccountName is used to check access from the current resource to a resource (eg. a remote Elasticsearch cluster) in a different namespace. Can only be used if ECK is enforcing RBAC on references.
 | *`remoteClusters`* __xref:{anchor_prefix}-github-com-elastic-cloud-on-k8s-pkg-apis-elasticsearch-v1-remotecluster[$$RemoteCluster$$] array__ | RemoteClusters enables you to establish uni-directional connections to a remote Elasticsearch cluster.
 | *`volumeClaimDeletePolicy`* __xref:{anchor_prefix}-github-com-elastic-cloud-on-k8s-pkg-apis-elasticsearch-v1-volumeclaimdeletepolicy[$$VolumeClaimDeletePolicy$$]__ | VolumeClaimDeletePolicy sets the policy for handling deletion of PersistentVolumeClaims for all NodeSets. Possible values are DeleteOnScaledownOnly and DeleteOnScaledownAndClusterDeletion. Defaults to DeleteOnScaledownAndClusterDeletion.
-| *`monitoring`* __xref:{anchor_prefix}-github-com-elastic-cloud-on-k8s-pkg-apis-elasticsearch-v1-monitoring[$$Monitoring$$]__ | Monitoring enables you to extract log and stack monitoring metrics of this Elasticsearch cluster. Metricbeat and Filebeat are deployed in the same pod as sidecar and each one send data to one or two different monitoring Elasticsearch clusters running in the same Kubernetes cluster.
+| *`monitoring`* __xref:{anchor_prefix}-github-com-elastic-cloud-on-k8s-pkg-apis-elasticsearch-v1-monitoring[$$Monitoring$$]__ | Monitoring enables you to extract log and Stack Monitoring metrics of this Elasticsearch cluster. Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one send data to one or two different monitoring Elasticsearch clusters running in the same Kubernetes cluster.
 |===
 
 
@@ -956,7 +956,7 @@ FileRealmSource references users to create in the Elasticsearch cluster.
 [cols="25a,75a", options="header"]
 |===
 | Field | Description
-| *`elasticsearchRef`* __xref:{anchor_prefix}-github-com-elastic-cloud-on-k8s-pkg-apis-common-v1-objectselector[$$ObjectSelector$$]__ | ElasticsearchRef is a reference to a monitoring Elasticsearch cluster running in the same Kubernetes cluster dedicated to receiving stack monitoring metrics.
+| *`elasticsearchRef`* __xref:{anchor_prefix}-github-com-elastic-cloud-on-k8s-pkg-apis-common-v1-objectselector[$$ObjectSelector$$]__ | ElasticsearchRef is a reference to a monitoring Elasticsearch cluster running in the same Kubernetes cluster dedicated to receiving Stack Monitoring metrics.
 |===
 
 

pkg/apis/common/v1/association.go

@@ -79,7 +79,7 @@ func (asm AssociationStatusMap) Single() (AssociationStatus, error) {
 	return result, nil
 }
 
-// AllEstablished returns true iff all Associations have AssociationEstablished status, false otherwise.
+// AllEstablished returns true if all Associations have AssociationEstablished status, false otherwise.
 func (asm AssociationStatusMap) AllEstablished() bool {
 	for _, status := range asm {
 		if status != AssociationEstablished {

pkg/apis/elasticsearch/v1/elasticsearch_types.go

@@ -78,8 +78,8 @@ type ElasticsearchSpec struct {
 	// +kubebuilder:validation:Enum=DeleteOnScaledownOnly;DeleteOnScaledownAndClusterDeletion
 	VolumeClaimDeletePolicy VolumeClaimDeletePolicy `json:"volumeClaimDeletePolicy,omitempty"`
 
-	// Monitoring enables you to extract log and stack monitoring metrics of this Elasticsearch cluster.
-	// Metricbeat and Filebeat are deployed in the same pod as sidecar and each one send data to one or two different
+	// Monitoring enables you to extract log and Stack Monitoring metrics of this Elasticsearch cluster.
+	// Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one send data to one or two different
 	// monitoring Elasticsearch clusters running in the same Kubernetes cluster.
 	// +kubebuilder:validation:Optional
 	Monitoring Monitoring `json:"monitoring,omitempty"`
@@ -93,7 +93,7 @@ type Monitoring struct {
 
 type MetricsMonitoring struct {
 	// ElasticsearchRef is a reference to a monitoring Elasticsearch cluster running in the same Kubernetes cluster
-	// dedicated to receiving stack monitoring metrics.
+	// dedicated to receiving Stack Monitoring metrics.
 	ElasticsearchRef commonv1.ObjectSelector `json:"elasticsearchRef,omitempty"`
 }
 
@@ -103,16 +103,16 @@ type LogsMonitoring struct {
 	ElasticsearchRef commonv1.ObjectSelector `json:"elasticsearchRef,omitempty"`
 }
 
-// EsEsAssociation helps to manage the Elasticsearch+Metricbeat+Filebeat <-> Elasticsearch(es) association
-type EsEsAssociation struct {
+// EsMonitoringAssociation helps to manage Elasticsearch+Metricbeat+Filebeat <-> Elasticsearch(es) associations
+type EsMonitoringAssociation struct {
 	*Elasticsearch
-	// ref is the namespaced name of the Elasticsearch used in Association
+	// ref is the namespaced name of the Elasticsearch referenced in the Association
 	ref types.NamespacedName
 }
 
-var _ commonv1.Association = &EsEsAssociation{}
+var _ commonv1.Association = &EsMonitoringAssociation{}
 
-func (eea *EsEsAssociation) Associated() commonv1.Associated {
+func (eea *EsMonitoringAssociation) Associated() commonv1.Associated {
 	if eea == nil {
 		return nil
 	}
@@ -122,7 +122,7 @@ func (eea *EsEsAssociation) Associated() commonv1.Associated {
 	return eea.Elasticsearch
 }
 
-func (eea *EsEsAssociation) AssociationConfAnnotationName() string {
+func (eea *EsMonitoringAssociation) AssociationConfAnnotationName() string {
 	// annotation key should be stable to allow Elasticsearch Controller only pick up the ones it expects,
 	// based on ElasticsearchRefs
 
@@ -140,18 +140,18 @@ func (eea *EsEsAssociation) AssociationConfAnnotationName() string {
 	)
 }
 
-func (eea *EsEsAssociation) AssociationType() commonv1.AssociationType {
+func (eea *EsMonitoringAssociation) AssociationType() commonv1.AssociationType {
 	return commonv1.ElasticsearchAssociationType
 }
 
-func (eea *EsEsAssociation) AssociationRef() commonv1.ObjectSelector {
+func (eea *EsMonitoringAssociation) AssociationRef() commonv1.ObjectSelector {
 	return commonv1.ObjectSelector{
 		Name:      eea.ref.Name,
 		Namespace: eea.ref.Namespace,
 	}
 }
 
-func (eea *EsEsAssociation) AssociationConf() *commonv1.AssociationConf {
+func (eea *EsMonitoringAssociation) AssociationConf() *commonv1.AssociationConf {
 	if eea.AssocConfs == nil {
 		return nil
 	}
@@ -163,7 +163,7 @@ func (eea *EsEsAssociation) AssociationConf() *commonv1.AssociationConf {
 	return &assocConf
 }
 
-func (eea *EsEsAssociation) SetAssociationConf(assocConf *commonv1.AssociationConf) {
+func (eea *EsMonitoringAssociation) SetAssociationConf(assocConf *commonv1.AssociationConf) {
 	if eea.AssocConfs == nil {
 		eea.AssocConfs = make(map[types.NamespacedName]commonv1.AssociationConf)
 	}
@@ -172,7 +172,7 @@ func (eea *EsEsAssociation) SetAssociationConf(assocConf *commonv1.AssociationCo
 	}
 }
 
-func (eea *EsEsAssociation) AssociationID() string {
+func (eea *EsMonitoringAssociation) AssociationID() string {
 	return fmt.Sprintf("%s-%s", eea.ref.Namespace, eea.ref.Name)
 }
 
@@ -188,14 +188,14 @@ func (es *Elasticsearch) GetAssociations() []commonv1.Association {
 	associations := make([]commonv1.Association, 0)
 	ref := es.Spec.Monitoring.Metrics.ElasticsearchRef
 	if ref.IsDefined() {
-		associations = append(associations, &EsEsAssociation{
+		associations = append(associations, &EsMonitoringAssociation{
 			Elasticsearch: es,
 			ref:           ref.WithDefaultNamespace(es.Namespace).NamespacedName(),
 		})
 	}
 	ref = es.Spec.Monitoring.Logs.ElasticsearchRef
 	if ref.IsDefined() {
-		associations = append(associations, &EsEsAssociation{
+		associations = append(associations, &EsMonitoringAssociation{
 			Elasticsearch: es,
 			ref:           ref.WithDefaultNamespace(es.Namespace).NamespacedName(),
 		})
@@ -206,23 +206,23 @@ func (es *Elasticsearch) GetAssociations() []commonv1.Association {
 func (es *Elasticsearch) GetMonitoringMetricsAssociation() commonv1.Association {
 	ref := es.Spec.Monitoring.Metrics.ElasticsearchRef
 	if ref.IsDefined() {
-		return &EsEsAssociation{
+		return &EsMonitoringAssociation{
 			Elasticsearch: es,
 			ref:           ref.WithDefaultNamespace(es.Namespace).NamespacedName(),
 		}
 	}
-	return &EsEsAssociation{}
+	return &EsMonitoringAssociation{}
 }
 
 func (es *Elasticsearch) GetMonitoringLogsAssociation() commonv1.Association {
 	ref := es.Spec.Monitoring.Logs.ElasticsearchRef
 	if ref.IsDefined() {
-		return &EsEsAssociation{
+		return &EsMonitoringAssociation{
 			Elasticsearch: es,
 			ref:           ref.WithDefaultNamespace(es.Namespace).NamespacedName(),
 		}
 	}
-	return &EsEsAssociation{}
+	return &EsMonitoringAssociation{}
 }
 
 func (es *Elasticsearch) AssociationStatusMap(typ commonv1.AssociationType) commonv1.AssociationStatusMap {
@@ -242,10 +242,6 @@ func (es *Elasticsearch) SetAssociationStatusMap(typ commonv1.AssociationType, s
 	return nil
 }
 
-/*func (es *Elasticsearch) AssociationID() string {
-	return commonv1.SingletonAssociationID
-}*/
-
 // VolumeClaimDeletePolicy describes the delete policy for handling PersistentVolumeClaims that hold Elasticsearch data.
 // Inspired by https://github.com/kubernetes/enhancements/pull/2440
 type VolumeClaimDeletePolicy string
@@ -541,7 +537,7 @@ type ElasticsearchStatus struct {
 }
 
 type ZenDiscoveryStatus struct {
-	MinimueeasterNodes int `json:"minimueeasterNodes,omitempty"`
+	MinimumMasterNodes int `json:"minimumMasterNodes,omitempty"`
 }
 
 // IsDegraded returns true if the current status is worse than the previous.

pkg/controller/association/controller/es_es.go → pkg/controller/association/controller/es_monitoring.go

@@ -18,18 +18,21 @@ import (
 )
 
 const (
-	// EsEsAssociationLabelName marks resources created by this controller for easier retrieval.
-	EsEsAssociationLabelName = "esesassociation.k8s.elastic.co/name"
-	// EsEsAssociationLabelNamespace marks resources created by this controller for easier retrieval.
-	EsEsAssociationLabelNamespace = "esesassociation.k8s.elastic.co/namespace"
-	// EsEsAssociationLabelType marks the type of association.
-	EsEsAssociationLabelType = "esesassociation.k8s.elastic.co/type"
+	// EsMonitoringAssociationLabelName marks resources created by this controller for easier retrieval.
+	EsMonitoringAssociationLabelName = "esmonitoringassociation.k8s.elastic.co/name"
+	// EsMonitoringAssociationLabelNamespace marks resources created by this controller for easier retrieval.
+	EsMonitoringAssociationLabelNamespace = "esmonitoringassociation.k8s.elastic.co/namespace"
+	// EsMonitoringAssociationLabelType marks the type of association.
+	EsMonitoringAssociationLabelType = "esmonitoringassociation.k8s.elastic.co/type"
 
 	// BeatBuiltinRole is the name of the built-in role for the Metricbeat/Filebeat system user.
 	BeatBuiltinRole = "superuser" // FIXME: create a dedicated role?
 )
 
-func AddEsEs(mgr manager.Manager, accessReviewer rbac.AccessReviewer, params operator.Parameters) error {
+// AddEsMonitoring reconciles an association between two Elasticsearch clusters for Stack Monitoring.
+// Beats are configured to collect monitoring metrics and logs data of the associated Elasticsearch and send
+// them to the Elasticsearch referenced in the association.
+func AddEsMonitoring(mgr manager.Manager, accessReviewer rbac.AccessReviewer, params operator.Parameters) error {
 	return association.AddAssociationController(mgr, accessReviewer, params, association.AssociationInfo{
 		AssociatedObjTemplate: func() commonv1.Associated { return &esv1.Elasticsearch{} },
 		ElasticsearchRef: func(c k8s.Client, association commonv1.Association) (bool, commonv1.ObjectSelector, error) {
@@ -39,17 +42,17 @@ func AddEsEs(mgr manager.Manager, accessReviewer rbac.AccessReviewer, params ope
 		ExternalServiceURL:        getElasticsearchExternalURL,
 		AssociationType:           commonv1.ElasticsearchAssociationType,
 		AssociatedNamer:           esv1.ESNamer,
-		AssociationName:           "es-es",
+		AssociationName:           "es-mon",
 		AssociatedShortName:       "es",
 		Labels: func(associated types.NamespacedName) map[string]string {
 			return map[string]string{
-				EsEsAssociationLabelName:      associated.Name,
-				EsEsAssociationLabelNamespace: associated.Namespace,
-				EsEsAssociationLabelType:      commonv1.ElasticsearchAssociationType,
+				EsMonitoringAssociationLabelName:      associated.Name,
+				EsMonitoringAssociationLabelNamespace: associated.Namespace,
+				EsMonitoringAssociationLabelType:      commonv1.ElasticsearchAssociationType,
 			}
 		},
 		AssociationConfAnnotationNameBase: commonv1.ElasticsearchConfigAnnotationNameBase,
-		UserSecretSuffix:                  "beat-user",
+		UserSecretSuffix:                  "beat-mon-user",
 		ESUserRole: func(associated commonv1.Associated) (string, error) {
 			return BeatBuiltinRole, nil
 		},

pkg/controller/common/defaults/pod_template.go

@@ -55,23 +55,27 @@ func NewPodTemplateBuilder(base corev1.PodTemplateSpec, containerName string) *P
 	return builder.setDefaults()
 }
 
+// getContainer retrieves the existing Container from the pod template
+func (b *PodTemplateBuilder) getContainer() *corev1.Container {
+	for i, c := range b.PodTemplate.Spec.Containers {
+		if c.Name == b.containerName {
+			return &b.PodTemplate.Spec.Containers[i]
+		}
+	}
+	return nil
+}
+func (b *PodTemplateBuilder) setContainerDefaulter() {
+	b.containerDefaulter = container.NewDefaulter(b.getContainer())
+}
+
 // setDefaults sets up a default Container in the pod template,
 // and disables service account token auto mount.
 func (b *PodTemplateBuilder) setDefaults() *PodTemplateBuilder {
-	// retrieve the existing Container from the pod template
-	getContainer := func() *corev1.Container {
-		for i, c := range b.PodTemplate.Spec.Containers {
-			if c.Name == b.containerName {
-				return &b.PodTemplate.Spec.Containers[i]
-			}
-		}
-		return nil
-	}
-	userContainer := getContainer()
+	userContainer := b.getContainer()
 	if userContainer == nil {
 		// create the default Container if not provided by the user
 		b.PodTemplate.Spec.Containers = append(b.PodTemplate.Spec.Containers, corev1.Container{Name: b.containerName})
-		b.containerDefaulter = container.NewDefaulter(getContainer())
+		b.setContainerDefaulter()
 	} else {
 		b.containerDefaulter = container.NewDefaulter(userContainer)
 	}
@@ -179,6 +183,15 @@ func (b *PodTemplateBuilder) WithTerminationGracePeriod(period int64) *PodTempla
 	return b
 }
 
+// WithContainer appends the given containers to the list of containers belonging to the pod.
+// It also ensures that the base container defaulter still points to the container in the list because append()
+// create a new slice.
+func (b *PodTemplateBuilder) WithContainers(containers ...corev1.Container) *PodTemplateBuilder {
+	b.PodTemplate.Spec.Containers = append(b.PodTemplate.Spec.Containers, containers...)
+	b.setContainerDefaulter()
+	return b
+}
+
 // WithInitContainerDefaults sets default values for the current init containers.
 //
 // Defaults: