Merge pull request #487 from paramite/ksm-new

Add kube-state-metrics for service monitoring

Author: openshift-merge-bot[bot]

api/bases/telemetry.openstack.org_ceilometers.yaml

@@ -30,6 +30,70 @@ spec:
               object represents. Servers may infer this from the endpoint the client
               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
             type: string
+          ksmStatus:
+            description: KSMStatus defines the observed state of kube-state-metrics
+            properties:
+              conditions:
+                description: Conditions
+                items:
+                  description: Condition defines an observation of a API resource
+                    operational state.
+                  properties:
+                    lastTransitionTime:
+                      description: Last time the condition transitioned from one status
+                        to another. This should be when the underlying condition changed.
+                        If that is not known, then using the time when the API field
+                        changed is acceptable.
+                      format: date-time
+                      type: string
+                    message:
+                      description: A human readable message indicating details about
+                        the transition.
+                      type: string
+                    reason:
+                      description: The reason for the condition's last transition
+                        in CamelCase.
+                      type: string
+                    severity:
+                      description: Severity provides a classification of Reason code,
+                        so the current situation is immediately understandable and
+                        could act accordingly. It is meant for situations where Status=False
+                        and it should be indicated if it is just informational, warning
+                        (next reconciliation might fix it) or an error (e.g. DB create
+                        issue and no actions to automatically resolve the issue can/should
+                        be done). For conditions where Status=Unknown or Status=True
+                        the Severity should be SeverityNone.
+                      type: string
+                    status:
+                      description: Status of the condition, one of True, False, Unknown.
+                      type: string
+                    type:
+                      description: Type of condition in CamelCase.
+                      type: string
+                  required:
+                  - lastTransitionTime
+                  - status
+                  - type
+                  type: object
+                type: array
+              hash:
+                additionalProperties:
+                  type: string
+                description: Map of hashes to track e.g. job status
+                type: object
+              observedGeneration:
+                description: ObservedGeneration - the most recent generation observed
+                  for this service. If the observed generation is less than the spec
+                  generation, then the controller has not processed the latest changes
+                  injected by the openstack-operator in the top-level CR (e.g. the
+                  ContainerImage)
+                format: int64
+                type: integer
+              readyCount:
+                description: ReadyCount of ksm instances
+                format: int32
+                type: integer
+            type: object
           metadata:
             type: object
           spec:
@@ -57,6 +121,19 @@ spec:
                 type: object
               ipmiImage:
                 type: string
+              ksmImage:
+                type: string
+              ksmTls:
+                description: KSMTLS - Parameters related to the TLS for kube-state-metrics
+                properties:
+                  caBundleSecretName:
+                    description: CaBundleSecretName - holding the CA certs in a pre-created
+                      bundle file
+                    type: string
+                  secretName:
+                    description: SecretName - holding the cert, key for the service
+                    type: string
+                type: object
               networkAttachmentDefinitions:
                 description: NetworkAttachmentDefinitions list of network attachment
                   definitions the service pod gets attached to
@@ -116,6 +193,7 @@ spec:
             - centralImage
             - computeImage
             - ipmiImage
+            - ksmImage
             - notificationImage
             - proxyImage
             - secret

api/bases/telemetry.openstack.org_telemetries.yaml

@@ -439,6 +439,19 @@ spec:
                     type: boolean
                   ipmiImage:
                     type: string
+                  ksmImage:
+                    type: string
+                  ksmTls:
+                    description: KSMTLS - Parameters related to the TLS for kube-state-metrics
+                    properties:
+                      caBundleSecretName:
+                        description: CaBundleSecretName - holding the CA certs in
+                          a pre-created bundle file
+                        type: string
+                      secretName:
+                        description: SecretName - holding the cert, key for the service
+                        type: string
+                    type: object
                   networkAttachmentDefinitions:
                     description: NetworkAttachmentDefinitions list of network attachment
                       definitions the service pod gets attached to
@@ -498,6 +511,7 @@ spec:
                 - centralImage
                 - computeImage
                 - ipmiImage
+                - ksmImage
                 - notificationImage
                 - proxyImage
                 - secret

api/v1beta1/ceilometer_types.go

@@ -20,8 +20,8 @@ import (
 	condition "github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
-	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/tls"
+	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 )
 
 const (
@@ -38,6 +38,8 @@ const (
 	// CeilometerProxyContainerImage - default fall-back image for proxy container
 	// CeilometerProxyContainerImage = "registry.redhat.io/ubi9/httpd-24:latest"
 	CeilometerProxyContainerImage = "quay.io/podified-antelope-centos9/openstack-aodh-api:current-podified"
+	// KubeStateMetricsImage - default fall-back image for KSM
+	KubeStateMetricsImage = "registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.10.0"
 )
 
 // CeilometerSpec defines the desired state of Ceilometer
@@ -62,6 +64,8 @@ type CeilometerSpec struct {
 	// +kubebuilder:validation:Required
 	ProxyImage string `json:"proxyImage"`
 
+	// +kubebuilder:validation:Required
+	KSMImage string `json:"ksmImage"`
 }
 
 // CeilometerSpecCore defines the desired state of Ceilometer. This version is used by the OpenStackControlplane (no image parameters)
@@ -103,6 +107,11 @@ type CeilometerSpecCore struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// TLS - Parameters related to the TLS
 	TLS tls.SimpleService `json:"tls,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// KSMTLS - Parameters related to the TLS for kube-state-metrics
+	KSMTLS tls.SimpleService `json:"ksmTls,omitempty"`
 }
 
 // CeilometerStatus defines the observed state of Ceilometer
@@ -129,6 +138,24 @@ type CeilometerStatus struct {
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }
 
+// KSMStatus defines the observed state of kube-state-metrics
+type KSMStatus struct {
+	// ReadyCount of ksm instances
+	ReadyCount int32 `json:"readyCount,omitempty"`
+
+	// Map of hashes to track e.g. job status
+	Hash map[string]string `json:"hash,omitempty"`
+
+	// Conditions
+	Conditions condition.Conditions `json:"conditions,omitempty" optional:"true"`
+
+	// ObservedGeneration - the most recent generation observed for this
+	// service. If the observed generation is less than the spec generation,
+	// then the controller has not processed the latest changes injected by
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+}
+
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
@@ -137,8 +164,9 @@ type Ceilometer struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   CeilometerSpec   `json:"spec,omitempty"`
-	Status CeilometerStatus `json:"status,omitempty"`
+	Spec             CeilometerSpec   `json:"spec,omitempty"`
+	CeilometerStatus CeilometerStatus `json:"status,omitempty"`
+	KSMStatus        KSMStatus        `json:"ksmStatus,omitempty"`
 }
 
 //+kubebuilder:object:root=true
@@ -152,7 +180,8 @@ type CeilometerList struct {
 
 // IsReady - returns true if Ceilometer is reconciled successfully
 func (instance Ceilometer) IsReady() bool {
-	return instance.Status.Conditions.IsTrue(condition.ReadyCondition)
+	return instance.CeilometerStatus.Conditions.IsTrue(condition.ReadyCondition) &&
+		instance.KSMStatus.Conditions.IsTrue(condition.ReadyCondition)
 }
 
 func init() {
@@ -161,7 +190,7 @@ func init() {
 
 // RbacConditionsSet - set the conditions for the rbac object
 func (instance Ceilometer) RbacConditionsSet(c *condition.Condition) {
-	instance.Status.Conditions.Set(c)
+	instance.CeilometerStatus.Conditions.Set(c)
 }
 
 // RbacNamespace - return the namespace
@@ -184,6 +213,7 @@ func SetupDefaultsCeilometer() {
 		ComputeContainerImageURL:      util.GetEnvVar("RELATED_IMAGE_CEILOMETER_COMPUTE_IMAGE_URL_DEFAULT", CeilometerComputeContainerImage),
 		IpmiContainerImageURL:         util.GetEnvVar("RELATED_IMAGE_CEILOMETER_IPMI_IMAGE_URL_DEFAULT", CeilometerIpmiContainerImage),
 		ProxyContainerImageURL:        util.GetEnvVar("RELATED_IMAGE_APACHE_IMAGE_URL_DEFAULT", CeilometerProxyContainerImage),
+		KSMContainerImageURL:          util.GetEnvVar("RELATED_IMAGE_KSM_IMAGE_URL_DEFAULT", KubeStateMetricsImage),
 	}
 
 	SetupCeilometerDefaults(ceilometerDefaults)

api/v1beta1/ceilometer_webhook.go

@@ -32,6 +32,7 @@ type CeilometerDefaults struct {
 	ComputeContainerImageURL      string
 	IpmiContainerImageURL         string
 	ProxyContainerImageURL        string
+	KSMContainerImageURL          string
 }
 
 var ceilometerDefaults CeilometerDefaults
@@ -85,6 +86,9 @@ func (spec *CeilometerSpec) Default() {
 	if spec.ProxyImage == "" {
 		spec.ProxyImage = ceilometerDefaults.ProxyContainerImageURL
 	}
+	if spec.KSMImage == "" {
+		spec.KSMImage = ceilometerDefaults.KSMContainerImageURL
+	}
 }
 
 // TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.

api/v1beta1/conditions.go

@@ -55,6 +55,9 @@ const (
 	DashboardDatasourceReadyCondition condition.Type = "DashboardDatasourceReady"
 
 	DashboardDefinitionReadyCondition condition.Type = "DashboardDefinitionReady"
+
+	// KSMReadyCondition Status=True condition which indicates if the KSM is configured and operational
+	KSMReadyCondition condition.Type = "KSMReady"
 )
 
 // Telemetry Reasons used by API objects.
@@ -189,4 +192,19 @@ const (
 
 	DashboardDefinitionReadyInitMessage = "Dashboard Definition not started"
 	DashboardDefinitionFailedMessage    = "Error occured when trying to install the dashboard definitions: %s"
+
+	//
+	// KSMReady condition messages
+	//
+	// KSMReadyInitMessage
+	KSMReadyInitMessage = "KSM not started"
+
+	// KSMReadyMessage
+	KSMReadyMessage = "KSM completed"
+
+	// KSMReadyErrorMessage
+	KSMReadyErrorMessage = "KSM error occured %s"
+
+	// KSMReadyRunningMessage
+	KSMReadyRunningMessage = "KSM in progress"
 )