[Metricbeat] Module for OpenShift/OKD

[sorantis]

Summary

OpenShift is a popular enterprise distribution of Kubernetes. Recently RedHat announced that
"Nearly 50% of the top Fortune 100 companies are using Red Hat OpenShift. Almost 30% of the top Fortune Global 500 companies use OpenShift".

While OpenShift product and Kubernetes project have a lot in common, there are some concepts that are different between the two systems. One such concept, specific to OpenShift is Multi-Project Quotas.

Definitions

OpenShift Projects are Kubernetes namespaces with additional annotations, which encapsulate a set of objects, accounts, policies and constraints.

Resource Quotas provide constraints that limit aggregate resource consumption per project. Resources managed by the ResourceQuota object can be found in the OpenShift documentation.

In OpenShift quotas can be shared across multiple projects, which means that an aggregate of resources used in each project is used to limit resources across all the selected projects. A multi-project quota is defined by a ClusterResourceQuota object in OpenShift.

The AppliedClusterResourceQuota resource can be used by each project's administrator to view the multi-project quota documents that are applied to his or her project.

These two objects only present in OpenShift and therefore won't be captured by the vanilla Metricbeat module for Kubernetes.

User Story

As an OpenShift administrator I want to be able to monitor multi-project quota metrics using Metricbeat so that I could see remaining and used resources for all projects as well as per project.

Having this Metricbeat module will complement the Kubernetes metricsets for both OpenShift Enterprise and OKD clusters.

[exekias]

Part of this issue should be about doing actual testing of our current deployment files on OpenShift + updating the docs if needed.

[ChrsMark]

Additional Resources

HAproxy

https://docs.openshift.com/container-platform/3.5/architecture/core_concepts/haproxy-router.html
https://wiki.berki.org/index.php/Openshift_-_HAproxy_metrics_EN

Openshift Builds

Monitor builds per cluster/project etc: https://docs.openshift.com/container-platform/3.9/dev_guide/builds/index.html, https://github.com/openshift/openshift-state-metrics/blob/master/docs/build-metrics.md

Machines

https://docs.openshift.com/container-platform/4.1/machine_management/creating-machineset.html

oc get machines --all-namespaces                                                                
NAMESPACE               NAME                     PHASE     TYPE            REGION        ZONE            AGE
openshift-machine-api   ocp-be-c5kjr-m-0         Running   n1-standard-4   us-central1   us-central1-a   7d19h
openshift-machine-api   ocp-be-c5kjr-m-1         Running   n1-standard-4   us-central1   us-central1-b   7d19h
openshift-machine-api   ocp-be-c5kjr-m-2         Running   n1-standard-4   us-central1   us-central1-c   7d19h
openshift-machine-api   ocp-be-c5kjr-w-a-fqn92   Running   n1-standard-4   us-central1   us-central1-a   7d19h
openshift-machine-api   ocp-be-c5kjr-w-b-jhqvn   Running   n1-standard-4   us-central1   us-central1-b   7d19h
openshift-machine-api   ocp-be-c5kjr-w-c-bsj76   Running   n1-standard-4   us-central1   us-central1-c   7d19h

Monitor Operator Status

https://docs.openshift.com/container-platform/4.2/operators/olm-status.html

openshift-state-metrics

https://github.com/openshift/openshift-state-metrics/blob/master/docs/README.md#exposed-metrics

[elasticmachine]

Pinging @elastic/integrations-platforms (Team:Platforms)

[botelastic]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[ChrsMark]

Still valid.

[botelastic]

Hi!
We just realized that we haven't looked into this issue in a while. We're sorry!

We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1.
Thank you for your contribution!

[pfulier]

Hi all, still valid, thanks.
:-)

[botelastic]

Hi!
We just realized that we haven't looked into this issue in a while. We're sorry!

We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1.
Thank you for your contribution!