| /* |
| Copyright 2019 Bloomberg Finance LP. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| package util |
| |
| import ( |
| "strconv" |
| "strings" |
| |
| solr "github.com/apache/lucene-solr-operator/api/v1beta1" |
| appsv1 "k8s.io/api/apps/v1" |
| corev1 "k8s.io/api/core/v1" |
| extv1 "k8s.io/api/extensions/v1beta1" |
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| "k8s.io/apimachinery/pkg/util/intstr" |
| ) |
| |
| const ( |
| SolrMetricsPort = 8080 |
| SolrMetricsPortName = "solr-metrics" |
| ExtSolrMetricsPort = 80 |
| |
| DefaultPrometheusExporterEntrypoint = "/opt/solr/contrib/prometheus-exporter/bin/solr-exporter" |
| ) |
| |
| // SolrConnectionInfo defines how to connect to a cloud or standalone solr instance. |
| // One, and only one, of Cloud or Standalone must be provided. |
| type SolrConnectionInfo struct { |
| CloudZkConnnectionInfo *solr.ZookeeperConnectionInfo |
| StandaloneAddress string |
| } |
| |
| // GenerateSolrPrometheusExporterDeployment returns a new appsv1.Deployment pointer generated for the SolrCloud Prometheus Exporter instance |
| // solrPrometheusExporter: SolrPrometheusExporter instance |
| func GenerateSolrPrometheusExporterDeployment(solrPrometheusExporter *solr.SolrPrometheusExporter, solrConnectionInfo SolrConnectionInfo) *appsv1.Deployment { |
| gracePeriodTerm := int64(10) |
| singleReplica := int32(1) |
| fsGroup := int64(SolrMetricsPort) |
| |
| labels := solrPrometheusExporter.SharedLabelsWith(solrPrometheusExporter.GetLabels()) |
| var annotations map[string]string |
| selectorLabels := solrPrometheusExporter.SharedLabels() |
| |
| labels["technology"] = solr.SolrPrometheusExporterTechnologyLabel |
| selectorLabels["technology"] = solr.SolrPrometheusExporterTechnologyLabel |
| |
| podLabels := labels |
| var podAnnotations map[string]string |
| |
| customDeploymentOptions := solrPrometheusExporter.Spec.CustomKubeOptions.DeploymentOptions |
| if nil != customDeploymentOptions { |
| labels = MergeLabelsOrAnnotations(labels, customDeploymentOptions.Labels) |
| annotations = customDeploymentOptions.Annotations |
| } |
| |
| customPodOptions := solrPrometheusExporter.Spec.CustomKubeOptions.PodOptions |
| if nil != customPodOptions { |
| podLabels = MergeLabelsOrAnnotations(podLabels, customPodOptions.Labels) |
| podAnnotations = customPodOptions.Annotations |
| } |
| |
| var envVars []corev1.EnvVar |
| var allJavaOpts []string |
| |
| var solrVolumes []corev1.Volume |
| var volumeMounts []corev1.VolumeMount |
| exporterArgs := []string{ |
| "-p", strconv.Itoa(SolrMetricsPort), |
| "-n", strconv.Itoa(int(solrPrometheusExporter.Spec.NumThreads)), |
| } |
| |
| if solrPrometheusExporter.Spec.ScrapeInterval > 0 { |
| exporterArgs = append(exporterArgs, "-s", strconv.Itoa(int(solrPrometheusExporter.Spec.ScrapeInterval))) |
| } |
| |
| // Setup the solrConnectionInfo |
| if solrConnectionInfo.CloudZkConnnectionInfo != nil { |
| exporterArgs = append(exporterArgs, "-z", solrConnectionInfo.CloudZkConnnectionInfo.ZkConnectionString()) |
| |
| // Add ACL information, if given, through Env Vars |
| if hasACLs, aclEnvs := AddACLsToEnv(solrConnectionInfo.CloudZkConnnectionInfo); hasACLs { |
| envVars = append(envVars, aclEnvs...) |
| |
| // The $SOLR_ZK_CREDS_AND_ACLS parameter does not get picked up when running the Prometheus Exporter, it must be added to the JAVA_OPTS. |
| allJavaOpts = append(allJavaOpts, "$(SOLR_ZK_CREDS_AND_ACLS)") |
| } |
| } else if solrConnectionInfo.StandaloneAddress != "" { |
| exporterArgs = append(exporterArgs, "-b", solrConnectionInfo.StandaloneAddress) |
| } |
| |
| // Only add the config if it is passed in from the user. Otherwise, use the default. |
| if solrPrometheusExporter.Spec.Config != "" { |
| solrVolumes = []corev1.Volume{{ |
| Name: "solr-prometheus-exporter-xml", |
| VolumeSource: corev1.VolumeSource{ |
| ConfigMap: &corev1.ConfigMapVolumeSource{ |
| LocalObjectReference: corev1.LocalObjectReference{ |
| Name: solrPrometheusExporter.MetricsConfigMapName(), |
| }, |
| Items: []corev1.KeyToPath{ |
| { |
| Key: "solr-prometheus-exporter.xml", |
| Path: "solr-prometheus-exporter.xml", |
| }, |
| }, |
| }, |
| }, |
| }} |
| |
| volumeMounts = []corev1.VolumeMount{{Name: "solr-prometheus-exporter-xml", MountPath: "/opt/solr-exporter", ReadOnly: true}} |
| |
| exporterArgs = append(exporterArgs, "-f", "/opt/solr-exporter/solr-prometheus-exporter.xml") |
| } else { |
| exporterArgs = append(exporterArgs, "-f", "/opt/solr/contrib/prometheus-exporter/conf/solr-exporter-config.xml") |
| } |
| |
| entrypoint := DefaultPrometheusExporterEntrypoint |
| if solrPrometheusExporter.Spec.ExporterEntrypoint != "" { |
| entrypoint = solrPrometheusExporter.Spec.ExporterEntrypoint |
| } |
| |
| // Add Custom EnvironmentVariables to the solr container |
| if nil != customPodOptions { |
| // Add environment variables to container |
| envVars = append(envVars, customPodOptions.EnvVariables...) |
| |
| // Add Custom Volumes to pod |
| for _, volume := range customPodOptions.Volumes { |
| volume.DefaultContainerMount.Name = volume.Name |
| |
| // Only add the container mount if one has been provided. |
| if volume.DefaultContainerMount != nil { |
| volumeMounts = append(volumeMounts, *volume.DefaultContainerMount) |
| } |
| |
| solrVolumes = append(solrVolumes, corev1.Volume{ |
| Name: volume.Name, |
| VolumeSource: volume.Source, |
| }) |
| } |
| } |
| |
| // Add JAVA_OPTS last, so that it can use values from all of the other ENV_VARS |
| if len(allJavaOpts) > 0 { |
| envVars = append(envVars, corev1.EnvVar{ |
| Name: "JAVA_OPTS", |
| Value: strings.Join(allJavaOpts, " "), |
| }) |
| } |
| |
| containers := []corev1.Container{ |
| { |
| Name: "solr-prometheus-exporter", |
| Image: solrPrometheusExporter.Spec.Image.ToImageName(), |
| ImagePullPolicy: solrPrometheusExporter.Spec.Image.PullPolicy, |
| Ports: []corev1.ContainerPort{{ContainerPort: SolrMetricsPort, Name: SolrMetricsPortName, Protocol: corev1.ProtocolTCP}}, |
| VolumeMounts: volumeMounts, |
| Command: []string{entrypoint}, |
| Args: exporterArgs, |
| Env: envVars, |
| |
| LivenessProbe: &corev1.Probe{ |
| Handler: corev1.Handler{ |
| HTTPGet: &corev1.HTTPGetAction{ |
| Scheme: corev1.URISchemeHTTP, |
| Path: "/metrics", |
| Port: intstr.FromInt(SolrMetricsPort), |
| }, |
| }, |
| InitialDelaySeconds: 20, |
| TimeoutSeconds: 1, |
| PeriodSeconds: 10, |
| SuccessThreshold: 1, |
| FailureThreshold: 3, |
| }, |
| }, |
| } |
| var initContainers []corev1.Container |
| |
| if customPodOptions != nil { |
| if len(customPodOptions.SidecarContainers) > 0 { |
| containers = append(containers, customPodOptions.SidecarContainers...) |
| } |
| |
| if len(customPodOptions.InitContainers) > 0 { |
| initContainers = customPodOptions.InitContainers |
| } |
| } |
| |
| deployment := &appsv1.Deployment{ |
| ObjectMeta: metav1.ObjectMeta{ |
| Name: solrPrometheusExporter.MetricsDeploymentName(), |
| Namespace: solrPrometheusExporter.GetNamespace(), |
| Labels: labels, |
| Annotations: annotations, |
| }, |
| Spec: appsv1.DeploymentSpec{ |
| Selector: &metav1.LabelSelector{ |
| MatchLabels: selectorLabels, |
| }, |
| Replicas: &singleReplica, |
| Template: corev1.PodTemplateSpec{ |
| ObjectMeta: metav1.ObjectMeta{ |
| Labels: podLabels, |
| Annotations: podAnnotations, |
| }, |
| Spec: corev1.PodSpec{ |
| TerminationGracePeriodSeconds: &gracePeriodTerm, |
| SecurityContext: &corev1.PodSecurityContext{ |
| FSGroup: &fsGroup, |
| }, |
| Volumes: solrVolumes, |
| InitContainers: initContainers, |
| Containers: containers, |
| }, |
| }, |
| }, |
| } |
| |
| if solrPrometheusExporter.Spec.Image.ImagePullSecret != "" { |
| deployment.Spec.Template.Spec.ImagePullSecrets = []corev1.LocalObjectReference{ |
| {Name: solrPrometheusExporter.Spec.Image.ImagePullSecret}, |
| } |
| } |
| |
| if nil != customPodOptions { |
| if customPodOptions.Affinity != nil { |
| deployment.Spec.Template.Spec.Affinity = customPodOptions.Affinity |
| } |
| |
| if customPodOptions.Resources.Requests != nil { |
| deployment.Spec.Template.Spec.Containers[0].Resources.Requests = customPodOptions.Resources.Requests |
| } |
| |
| if customPodOptions.Resources.Limits != nil { |
| deployment.Spec.Template.Spec.Containers[0].Resources.Limits = customPodOptions.Resources.Limits |
| } |
| |
| if customPodOptions.PodSecurityContext != nil { |
| deployment.Spec.Template.Spec.SecurityContext = customPodOptions.PodSecurityContext |
| } |
| |
| if customPodOptions.Tolerations != nil { |
| deployment.Spec.Template.Spec.Tolerations = customPodOptions.Tolerations |
| } |
| |
| if customPodOptions.NodeSelector != nil { |
| deployment.Spec.Template.Spec.NodeSelector = customPodOptions.NodeSelector |
| } |
| |
| if customPodOptions.PriorityClassName != "" { |
| deployment.Spec.Template.Spec.PriorityClassName = customPodOptions.PriorityClassName |
| } |
| } |
| |
| return deployment |
| } |
| |
| // GenerateMetricsConfigMap returns a new corev1.ConfigMap pointer generated for the Solr Prometheus Exporter instance solr-prometheus-exporter.xml |
| // solrPrometheusExporter: SolrPrometheusExporter instance |
| func GenerateMetricsConfigMap(solrPrometheusExporter *solr.SolrPrometheusExporter) *corev1.ConfigMap { |
| labels := solrPrometheusExporter.SharedLabelsWith(solrPrometheusExporter.GetLabels()) |
| var annotations map[string]string |
| |
| customOptions := solrPrometheusExporter.Spec.CustomKubeOptions.ConfigMapOptions |
| if nil != customOptions { |
| labels = MergeLabelsOrAnnotations(labels, customOptions.Labels) |
| annotations = customOptions.Annotations |
| } |
| |
| configMap := &corev1.ConfigMap{ |
| ObjectMeta: metav1.ObjectMeta{ |
| Name: solrPrometheusExporter.MetricsConfigMapName(), |
| Namespace: solrPrometheusExporter.GetNamespace(), |
| Labels: labels, |
| Annotations: annotations, |
| }, |
| Data: map[string]string{ |
| "solr-prometheus-exporter.xml": solrPrometheusExporter.Spec.Config, |
| }, |
| } |
| return configMap |
| } |
| |
| // GenerateSolrMetricsService returns a new corev1.Service pointer generated for the SolrCloud Prometheus Exporter deployment |
| // Metrics will be collected on this service endpoint, as we don't want to double-tick data if multiple exporters are runnning. |
| // solrPrometheusExporter: solrPrometheusExporter instance |
| func GenerateSolrMetricsService(solrPrometheusExporter *solr.SolrPrometheusExporter) *corev1.Service { |
| copyLabels := solrPrometheusExporter.GetLabels() |
| if copyLabels == nil { |
| copyLabels = map[string]string{} |
| } |
| labels := solrPrometheusExporter.SharedLabelsWith(solrPrometheusExporter.GetLabels()) |
| labels["service-type"] = "metrics" |
| annotations := map[string]string{ |
| "prometheus.io/scrape": "true", |
| "prometheus.io/scheme": "http", |
| "prometheus.io/path": "/metrics", |
| "prometheus.io/port": strconv.Itoa(ExtSolrMetricsPort), |
| } |
| |
| selectorLabels := solrPrometheusExporter.SharedLabels() |
| selectorLabels["technology"] = solr.SolrPrometheusExporterTechnologyLabel |
| |
| customOptions := solrPrometheusExporter.Spec.CustomKubeOptions.ServiceOptions |
| if nil != customOptions { |
| labels = MergeLabelsOrAnnotations(labels, customOptions.Labels) |
| annotations = MergeLabelsOrAnnotations(annotations, customOptions.Annotations) |
| } |
| |
| service := &corev1.Service{ |
| ObjectMeta: metav1.ObjectMeta{ |
| Name: solrPrometheusExporter.MetricsServiceName(), |
| Namespace: solrPrometheusExporter.GetNamespace(), |
| Labels: labels, |
| Annotations: annotations, |
| }, |
| Spec: corev1.ServiceSpec{ |
| Ports: []corev1.ServicePort{ |
| {Name: SolrMetricsPortName, Port: ExtSolrMetricsPort, Protocol: corev1.ProtocolTCP, TargetPort: intstr.FromInt(SolrMetricsPort)}, |
| }, |
| Selector: selectorLabels, |
| }, |
| } |
| return service |
| } |
| |
| // CreateMetricsIngressRule returns a new Ingress Rule generated for the solr metrics endpoint |
| // This is not currently used, as an ingress is not created for the metrics endpoint. |
| // solrCloud: SolrCloud instance |
| // nodeName: string Name of the node |
| // ingressBaseDomain: string base domain for the ingress controller |
| func CreateMetricsIngressRule(solrPrometheusExporter *solr.SolrPrometheusExporter, ingressBaseDomain string) extv1.IngressRule { |
| externalAddress := solrPrometheusExporter.MetricsIngressUrl(ingressBaseDomain) |
| return extv1.IngressRule{ |
| Host: externalAddress, |
| IngressRuleValue: extv1.IngressRuleValue{ |
| HTTP: &extv1.HTTPIngressRuleValue{ |
| Paths: []extv1.HTTPIngressPath{ |
| { |
| Backend: extv1.IngressBackend{ |
| ServiceName: solrPrometheusExporter.MetricsServiceName(), |
| ServicePort: intstr.FromInt(ExtSolrMetricsPort), |
| }, |
| }, |
| }, |
| }, |
| }, |
| } |
| } |