This repo contains the image definitions for the components of the cluster logging stack as well as tools for building and deploying them. The cluster logging subsystem consists of multiple components abbreviated as the "EFK" stack: Elasticsearch, Fluentd, Kibana.
The primary features this integration provides: * Multitenant support to isolate logs from various project namespaces * Openshift OAuth2 integration * Historical log discovery and visualization * Log aggregation of pod and node logs
Please check the release notes for deprecated features or breaking changes .
The cluster logging subsystem consists of multiple components commonly abbreviated as the "ELK" stack (though modified here to be the "EFK" stack).
Elasticsearch is a Lucene-based indexing object store into which logs are fed. Logs for node services and all containers in the cluster are fed into one deployed cluster. The Elasticsearch cluster should be deployed with redundancy and persistent storage for scale and high availability.
Fluentd is responsible for gathering log entries from nodes, enriching them with metadata, and feeding them into Elasticsearch.
Kibana presents a web UI for browsing and visualizing logs in Elasticsearch.
In order to authenticate the Kibana user against OpenShift's Oauth2, a proxy is required that runs in front of Kibana.
Curator allows the admin to remove old indices from Elasticsearch on a per-project basis.
The cluster-logging-operator orchestrates the deployment of the cluster logging stack including: resource definitions, key/cert generation, component start and stop order.
Determining the health of an EFK deployment and if it is running can be assessed by running the
check-logs.she2e tests. Additionally, see Checking EFK Health
Any issues against the origin stack can be filed at https://github.com/openshift/origin-aggregated-logging/issues. Please include as many details as possible in order to assist us in resolving the issue.
Use curl to grab the tarball from github:
curl -s -L https://api.github.com/repos/ORG-or-USERNAME/REPO/tarball/BRANCH | tar -C hack/vendor/olm-test-script --strip-components=1 -x -z -f -for example:
curl -s -L https://api.github.com/repos/shawn-hurley/olm-test-script/tarball/master | tar -C hack/vendor/olm-test-script --strip-components=1 -x -z -f -
To contribute to the development of origin-aggregated-logging, see REVIEW.md