Introduce EnterpriseSearch CRD #2688
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Remove validation.openAPIV3Schema.type that causes failures on k8s 1.11. | ||
| # This should have been fixed with https://github.com/kubernetes-sigs/controller-tools/pull/72, but it looks like | ||
| # this commit has been lost in history. See https://github.com/kubernetes-sigs/controller-tools/issues/296. | ||
| # TODO: remove once fixed in controller-tools | ||
| - op: remove | ||
| path: /spec/validation/openAPIV3Schema/type | ||
|
|
||
| # Using `kubectl apply` stores the complete CRD file as an annotation, | ||
| # which may be too big for the annotations size limit. | ||
| # One way to mitigate this problem is to remove the (huge) podTemplate properties from the CRD. | ||
| # It also avoids the problem of having any k8s-version specific field in the Pod schema, | ||
| # that would maybe not match the user's k8s version. | ||
| - op: remove | ||
| path: /spec/validation/openAPIV3Schema/properties/spec/properties/podTemplate/properties | ||
|
|
||
| # TODO: remove once https://github.com/kubernetes-sigs/controller-tools/issues/392 is fixed | ||
| # without this the API server complains with "The CustomResourceDefinition "elasticsearches.elasticsearch.k8s.elastic.co" | ||
| # is invalid: spec.validation.openAPIV3Schema.type: Required value: must not be empty at the root" | ||
| - op: remove | ||
| path: /spec/validation/openAPIV3Schema/properties/spec/properties/http/properties/service/properties/spec/properties/ports/items/properties/targetPort/x-kubernetes-int-or-string | ||
|
|
||
| # TODO: remove once https://github.com/kubernetes-sigs/controller-tools/issues/392 is fixed | ||
| # these are not technically required by the API server, but kubectl validation will fail because | ||
| # of these markers so we remove them to make applying the CRDs easier. | ||
| - op: remove | ||
| path: /spec/validation/openAPIV3Schema/properties/spec/properties/http/properties/service/properties/spec/properties/ports/x-kubernetes-list-map-keys | ||
| - op: remove | ||
| path: /spec/validation/openAPIV3Schema/properties/spec/properties/http/properties/service/properties/spec/properties/ports/x-kubernetes-list-type |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # This sample sets up an Elasticsearch cluster and a Enterprise Search instance preconfigured for that cluster | ||
| apiVersion: elasticsearch.k8s.elastic.co/v1 | ||
| kind: Elasticsearch | ||
| metadata: | ||
| name: elasticsearch-sample | ||
| spec: | ||
| version: 7.6.0 | ||
| nodeSets: | ||
| - name: default | ||
| count: 1 | ||
| config: | ||
| # This setting could have performance implications for production clusters. | ||
| # See: https://www.elastic.co/guide/en/cloud-on-k8s/master/k8s-virtual-memory.html | ||
| node.store.allow_mmap: false | ||
| --- | ||
| apiVersion: enterprisesearch.k8s.elastic.co/v1beta1 | ||
| kind: EnterpriseSearch | ||
| metadata: | ||
| name: entsearch-sample | ||
| spec: | ||
| version: 7.6.0 | ||
| image: $DOCKER_IMAGE | ||
| count: 1 | ||
| elasticsearchRef: | ||
| name: elasticsearch-sample | ||
| config: | ||
| ent_search.external_url: https://localhost:3002 | ||
| http: | ||
| # service: | ||
| # spec: | ||
| # type: LoadBalancer | ||
| tls: | ||
| selfSignedCertificate: | ||
| subjectAltNames: | ||
| - dns: localhost | ||
| # http: | ||
| # service: | ||
| # spec: | ||
| # type: LoadBalancer | ||
| # podTemplate: | ||
| # spec: | ||
| # containers: | ||
| # - name: enterprise-search | ||
| # resources: | ||
| # requests: | ||
| # cpu: 4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| // or more contributor license agreements. Licensed under the Elastic License; | ||
| // you may not use this file except in compliance with the Elastic License. | ||
|
|
||
| // Package v1beta1 contains API schema definitions for managing Enterprise Search resources. | ||
| // +kubebuilder:object:generate=true | ||
| // +groupName=enterprisesearch.k8s.elastic.co | ||
| package v1beta1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| // or more contributor license agreements. Licensed under the Elastic License; | ||
| // you may not use this file except in compliance with the Elastic License. | ||
|
|
||
| package v1beta1 | ||
|
|
||
| import ( | ||
| commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| const EnterpriseSearchContainerName = "enterprise-search" | ||
|
|
||
| // EnterpriseSearchSpec holds the specification of an Enterprise Search resource. | ||
| type EnterpriseSearchSpec struct { | ||
| // Version of Enterprise Search. | ||
| Version string `json:"version,omitempty"` | ||
|
|
||
| // Image is the Enterprise Search Docker image to deploy. | ||
| Image string `json:"image,omitempty"` | ||
|
|
||
| // Count of Enterprise Search instances to deploy. | ||
| Count int32 `json:"count,omitempty"` | ||
|
|
||
| // Config holds the Enterprise Search configuration. | ||
| Config *commonv1.Config `json:"config,omitempty"` | ||
|
|
||
| // HTTP holds the HTTP layer configuration for Enterprise Search resource. | ||
| HTTP commonv1.HTTPConfig `json:"http,omitempty"` | ||
|
|
||
| // ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster. | ||
sebgl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ElasticsearchRef commonv1.ObjectSelector `json:"elasticsearchRef,omitempty"` | ||
|
|
||
| // PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) | ||
| // for the Enterprise Search pods. | ||
| // +kubebuilder:validation:Optional | ||
| PodTemplate corev1.PodTemplateSpec `json:"podTemplate,omitempty"` | ||
|
|
||
| // ServiceAccountName is used to check access from the current resource to a resource (eg. Elasticsearch) in a different namespace. | ||
| // Can only be used if ECK is enforcing RBAC on references. | ||
| // +optional | ||
| ServiceAccountName string `json:"serviceAccountName,omitempty"` | ||
| } | ||
|
|
||
| func (spec EnterpriseSearchSpec) Protocol() string { | ||
| if spec.HTTP.TLS.Enabled() { | ||
sebgl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return "https" | ||
| } | ||
| return "http" | ||
| } | ||
|
|
||
| // EnterpriseSearchHealth expresses the health of the Enterprise Search instances. | ||
| type EnterpriseSearchHealth string | ||
|
|
||
| const ( | ||
| // EnterpriseSearchRed means no instance is currently available. | ||
| EnterpriseSearchRed EnterpriseSearchHealth = "red" | ||
| // EnterpriseSearchGreen means at least one instance is available. | ||
| EnterpriseSearchGreen EnterpriseSearchHealth = "green" | ||
| ) | ||
|
|
||
| // EnterpriseSearchStatus defines the observed state of EnterpriseSearch | ||
| type EnterpriseSearchStatus struct { | ||
| commonv1.ReconcilerStatus `json:",inline"` | ||
| Health EnterpriseSearchHealth `json:"health,omitempty"` | ||
| // ExternalService is the name of the service associated to the Enterprise Search Pods. | ||
| ExternalService string `json:"service,omitempty"` | ||
| // Association is the status of any auto-linking to Elasticsearch clusters. | ||
| Association commonv1.AssociationStatus `json:"associationStatus,omitempty"` | ||
| } | ||
|
|
||
| // IsDegraded returns true if the current status is worse than the previous. | ||
| func (ents EnterpriseSearchStatus) IsDegraded(prev EnterpriseSearchStatus) bool { | ||
| return prev.Health == EnterpriseSearchGreen && ents.Health != EnterpriseSearchRed | ||
| } | ||
|
|
||
| // IsMarkedForDeletion returns true if the EnterpriseSearch is going to be deleted | ||
| func (ents *EnterpriseSearch) IsMarkedForDeletion() bool { | ||
| return !ents.DeletionTimestamp.IsZero() | ||
| } | ||
|
|
||
| func (ents *EnterpriseSearch) ServiceAccountName() string { | ||
| return ents.Spec.ServiceAccountName | ||
| } | ||
|
|
||
| func (ents *EnterpriseSearch) ElasticsearchRef() commonv1.ObjectSelector { | ||
| return ents.Spec.ElasticsearchRef | ||
| } | ||
|
|
||
| func (ents *EnterpriseSearch) AssociationConf() *commonv1.AssociationConf { | ||
| return ents.assocConf | ||
| } | ||
|
|
||
| func (ents *EnterpriseSearch) SetAssociationConf(assocConf *commonv1.AssociationConf) { | ||
| ents.assocConf = assocConf | ||
| } | ||
|
|
||
| // +kubebuilder:object:root=true | ||
|
|
||
| // EnterpriseSearch is a Kubernetes CRD to represent Enterprise Search. | ||
| // +kubebuilder:resource:categories=elastic,shortName=entsearch | ||
| // +kubebuilder:subresource:status | ||
| // +kubebuilder:printcolumn:name="health",type="string",JSONPath=".status.health" | ||
| // +kubebuilder:printcolumn:name="nodes",type="integer",JSONPath=".status.availableNodes",description="Available nodes" | ||
| // +kubebuilder:printcolumn:name="version",type="string",JSONPath=".spec.version",description="Enterprise Search version" | ||
| // +kubebuilder:printcolumn:name="age",type="date",JSONPath=".metadata.creationTimestamp" | ||
| // +kubebuilder:storageversion | ||
| type EnterpriseSearch struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec EnterpriseSearchSpec `json:"spec,omitempty"` | ||
| Status EnterpriseSearchStatus `json:"status,omitempty"` | ||
| assocConf *commonv1.AssociationConf `json:"-"` //nolint:govet | ||
| } | ||
|
|
||
| // +kubebuilder:object:root=true | ||
|
|
||
| // EnterpriseSearchList contains a list of EnterpriseSearch | ||
| type EnterpriseSearchList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
| Items []EnterpriseSearch `json:"items"` | ||
| } | ||
|
|
||
| func init() { | ||
| SchemeBuilder.Register(&EnterpriseSearch{}, &EnterpriseSearchList{}) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Proper name here is Enterprise Search, two words.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This really refers to the
EnterpriseSearch CRD(the technical implementation), I'd be in favor of keeping it as is. Also this is def not a user-facing file.