Simplify setup of Enterprise Search access through Kibana UI

cmd/manager/main.go

@@ -672,6 +672,7 @@ func registerControllers(mgr manager.Manager, params operator.Parameters, access
 		{name: "APM-ES", registerFunc: associationctl.AddApmES},
 		{name: "APM-KB", registerFunc: associationctl.AddApmKibana},
 		{name: "KB-ES", registerFunc: associationctl.AddKibanaES},
+		{name: "KB-ENT", registerFunc: associationctl.AddKibanaEnt},
 		{name: "ENT-ES", registerFunc: associationctl.AddEntES},
 		{name: "BEAT-ES", registerFunc: associationctl.AddBeatES},
 		{name: "BEAT-KB", registerFunc: associationctl.AddBeatKibana},
@@ -708,7 +709,7 @@ func garbageCollectUsers(cfg *rest.Config, managedNamespaces []string) {
 	}
 	err = ugc.
 		For(&apmv1.ApmServerList{}, associationctl.ApmAssociationLabelNamespace, associationctl.ApmAssociationLabelName).
-		For(&kbv1.KibanaList{}, associationctl.KibanaESAssociationLabelNamespace, associationctl.KibanaESAssociationLabelName).
+		For(&kbv1.KibanaList{}, associationctl.KibanaAssociationLabelNamespace, associationctl.KibanaAssociationLabelName).
 		For(&entv1.EnterpriseSearchList{}, associationctl.EntESAssociationLabelNamespace, associationctl.EntESAssociationLabelName).
 		For(&beatv1beta1.BeatList{}, associationctl.BeatAssociationLabelNamespace, associationctl.BeatAssociationLabelName).
 		For(&agentv1alpha1.AgentList{}, associationctl.AgentAssociationLabelNamespace, associationctl.AgentAssociationLabelName).

config/crds/v1/all-crds.yaml

@@ -6136,6 +6136,28 @@ spec:
                 required:
                 - name
                 type: object
+              enterpriseSearchRef:
+                description: EnterpriseSearchRef is a reference to an EnterpriseSearch
+                  running in the same Kubernetes cluster. Kibana provides the default
+                  Enterprise Search UI starting version 7.14.
+                properties:
+                  name:
+                    description: Name of the Kubernetes object.
+                    type: string
+                  namespace:
+                    description: Namespace of the Kubernetes object. If empty, defaults
+                      to the current namespace.
+                    type: string
+                  serviceName:
+                    description: ServiceName is the name of an existing Kubernetes
+                      service which will be used to make requests to the referenced
+                      object. It has to be in the same namespace as the referenced
+                      resource. If left empty the default HTTP service of the referenced
+                      resource will be used.
+                    type: string
+                required:
+                - name
+                type: object
               http:
                 description: HTTP holds the HTTP layer configuration for Kibana.
                 properties:
@@ -6630,13 +6652,20 @@ spec:
             description: KibanaStatus defines the observed state of Kibana
             properties:
               associationStatus:
-                description: AssociationStatus is the status of an association resource.
+                description: AssociationStatus is the status of any auto-linking to
+                  Elasticsearch clusters. This was kept as "associationStatus" rather
+                  than a more consistent "elasticsearchAssociationStatus" for backward-compatibility
+                  reasons.
                 type: string
               availableNodes:
                 description: AvailableNodes is the number of available replicas in
                   the deployment.
                 format: int32
                 type: integer
+              enterpriseSearchAssociationStatus:
+                description: EnterpriseSearchAssociationStatus is the status of any
+                  auto-linking to Enterprise Search.
+                type: string
               health:
                 description: Health of the deployment.
                 type: string

config/crds/v1/bases/kibana.k8s.elastic.co_kibanas.yaml

@@ -84,6 +84,28 @@ spec:
                 required:
                 - name
                 type: object
+              enterpriseSearchRef:
+                description: EnterpriseSearchRef is a reference to an EnterpriseSearch
+                  running in the same Kubernetes cluster. Kibana provides the default
+                  Enterprise Search UI starting version 7.14.
+                properties:
+                  name:
+                    description: Name of the Kubernetes object.
+                    type: string
+                  namespace:
+                    description: Namespace of the Kubernetes object. If empty, defaults
+                      to the current namespace.
+                    type: string
+                  serviceName:
+                    description: ServiceName is the name of an existing Kubernetes
+                      service which will be used to make requests to the referenced
+                      object. It has to be in the same namespace as the referenced
+                      resource. If left empty the default HTTP service of the referenced
+                      resource will be used.
+                    type: string
+                required:
+                - name
+                type: object
               http:
                 description: HTTP holds the HTTP layer configuration for Kibana.
                 properties:
@@ -7263,13 +7285,20 @@ spec:
             description: KibanaStatus defines the observed state of Kibana
             properties:
               associationStatus:
-                description: AssociationStatus is the status of an association resource.
+                description: AssociationStatus is the status of any auto-linking to
+                  Elasticsearch clusters. This was kept as "associationStatus" rather
+                  than a more consistent "elasticsearchAssociationStatus" for backward-compatibility
+                  reasons.
                 type: string
               availableNodes:
                 description: AvailableNodes is the number of available replicas in
                   the deployment.
                 format: int32
                 type: integer
+              enterpriseSearchAssociationStatus:
+                description: EnterpriseSearchAssociationStatus is the status of any
+                  auto-linking to Enterprise Search.
+                type: string
               health:
                 description: Health of the deployment.
                 type: string

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

@@ -6181,6 +6181,28 @@ spec:
                 required:
                 - name
                 type: object
+              enterpriseSearchRef:
+                description: EnterpriseSearchRef is a reference to an EnterpriseSearch
+                  running in the same Kubernetes cluster. Kibana provides the default
+                  Enterprise Search UI starting version 7.14.
+                properties:
+                  name:
+                    description: Name of the Kubernetes object.
+                    type: string
+                  namespace:
+                    description: Namespace of the Kubernetes object. If empty, defaults
+                      to the current namespace.
+                    type: string
+                  serviceName:
+                    description: ServiceName is the name of an existing Kubernetes
+                      service which will be used to make requests to the referenced
+                      object. It has to be in the same namespace as the referenced
+                      resource. If left empty the default HTTP service of the referenced
+                      resource will be used.
+                    type: string
+                required:
+                - name
+                type: object
               http:
                 description: HTTP holds the HTTP layer configuration for Kibana.
                 properties:
@@ -6675,13 +6697,20 @@ spec:
             description: KibanaStatus defines the observed state of Kibana
             properties:
               associationStatus:
-                description: AssociationStatus is the status of an association resource.
+                description: AssociationStatus is the status of any auto-linking to
+                  Elasticsearch clusters. This was kept as "associationStatus" rather
+                  than a more consistent "elasticsearchAssociationStatus" for backward-compatibility
+                  reasons.
                 type: string
               availableNodes:
                 description: AvailableNodes is the number of available replicas in
                   the deployment.
                 format: int32
                 type: integer
+              enterpriseSearchAssociationStatus:
+                description: EnterpriseSearchAssociationStatus is the status of any
+                  auto-linking to Enterprise Search.
+                type: string
               health:
                 description: Health of the deployment.
                 type: string

pkg/apis/common/v1/association.go

@@ -96,6 +96,9 @@ const (
 	KibanaConfigAnnotationNameBase = "association.k8s.elastic.co/kb-conf"
 	KibanaAssociationType          = "kibana"
 
+	EntConfigAnnotationNameBase = "association.k8s.elastic.co/ent-conf"
+	EntAssociationType          = "ent"
+
 	AssociationUnknown     AssociationStatus = ""
 	AssociationPending     AssociationStatus = "Pending"
 	AssociationEstablished AssociationStatus = "Established"
@@ -106,6 +109,10 @@ const (
 	// should use `SingletonAssociationID` as their `AssociationID`. On the contrary, Agent can have unbounded number
 	// of Associations so Agent-ES Associations should _not_ use `SingletonAssociationID`.
 	SingletonAssociationID = ""
+
+	// NoAuthRequiredValue is the value set for AuthSecretName if no authentication
+	// credentials are necessary for that association.
+	NoAuthRequiredValue = "-"
 )
 
 // Associated represents an Elastic stack resource that is associated with other stack resources.
@@ -193,14 +200,23 @@ func (ac *AssociationConf) IsConfigured() bool {
 	return ac.AuthIsConfigured() && ac.URLIsConfigured()
 }
 
-// AuthIsConfigured returns true if all the auth fields are set.
+// AuthIsConfigured returns true if the auth fields are set.
 func (ac *AssociationConf) AuthIsConfigured() bool {
 	if ac == nil {
 		return false
 	}
+	if ac.NoAuthRequired() {
+		// auth fields are not required, but still configured
+		return true
+	}
+	// ensure both secret name and secret key are provided
 	return ac.AuthSecretName != "" && ac.AuthSecretKey != ""
 }
 
+func (ac *AssociationConf) NoAuthRequired() bool {
+	return ac.AuthSecretName == NoAuthRequiredValue
+}
+
 // CAIsConfigured returns true if the CA field is set.
 func (ac *AssociationConf) CAIsConfigured() bool {
 	if ac == nil {

pkg/apis/common/v1/association_test.go

@@ -80,6 +80,15 @@ func TestAssociationConfIsConfigured(t *testing.T) {
 			},
 			want: true,
 		},
+		{
+			name: "correctly configured with no auth required",
+			assocConf: &AssociationConf{
+				AuthSecretName: "-",
+				CASecretName:   "ca-secret",
+				URL:            "https://my-es.svc",
+			},
+			want: true,
+		},
 	}
 
 	for _, tt := range tests {
@@ -252,3 +261,59 @@ func TestAssociationStatusMap_String(t *testing.T) {
 		})
 	}
 }
+
+func TestAssociationConf_AuthIsConfigured(t *testing.T) {
+	type fields struct {
+		AuthSecretName string
+		AuthSecretKey  string
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   bool
+	}{
+		{
+			name: "auth configured",
+			fields: fields{
+				AuthSecretName: "secret-name",
+				AuthSecretKey:  "secret-key",
+			},
+			want: true,
+		},
+		{
+			name: "auth secret key not configured",
+			fields: fields{
+				AuthSecretName: "secret-name",
+				AuthSecretKey:  "",
+			},
+			want: false,
+		},
+		{
+			name: "auth not configured",
+			fields: fields{
+				AuthSecretName: "",
+				AuthSecretKey:  "",
+			},
+			want: false,
+		},
+		{
+			name: "auth not required (but still configured)",
+			fields: fields{
+				AuthSecretName: "-",
+				AuthSecretKey:  "",
+			},
+			want: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ac := &AssociationConf{
+				AuthSecretName: tt.fields.AuthSecretName,
+				AuthSecretKey:  tt.fields.AuthSecretKey,
+			}
+			if got := ac.AuthIsConfigured(); got != tt.want {
+				t.Errorf("AuthIsConfigured() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

pkg/apis/enterprisesearch/v1/enterprisesearch_types.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 
 	commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
+	common_name "github.com/elastic/cloud-on-k8s/pkg/controller/common/name"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -19,6 +20,9 @@ const (
 	Kind = "EnterpriseSearch"
 )
 
+// Namer is a Namer that is configured with the defaults for resources related to an EnterpriseSearch resource.
+var Namer = common_name.NewNamer("ent")
+
 // EnterpriseSearchSpec holds the specification of an Enterprise Search resource.
 type EnterpriseSearchSpec struct {
 	// Version of Enterprise Search.