-
Story
-
Resolution: Done
-
Minor
-
None
-
None
-
Jango [Quay 177], Kamino [Quay 178], Lando [Quay 179], Mustafar [Quay 180], Naboo [Quay 181], Obi-Wan [Quay 182]
Currently all usage logs of Quay for the last 3 months are stored in the database and exposed via UI on an organization or repo level. Equivalent admin privileges are required to see them.
For large deployments with a huge amount of logged operations it's now possible to store the usage logs in Elasticsearch instead of the Quay database backend. The required Elasticsearch stack is a BYO customer prerequisite. We do not ship the backend with Quay or any other product as a customizable component. Using the OpenShift built-in Elasticsearch stack is planned for 3.4, see https://issues.redhat.com/browse/PROJQUAY-290 for further details.
Access control still happens via Quay (admin privileges required), no further impact on the Quay UI or usage patterns.
The feature needs to be enabled via the Config App and has corresponding entries in the config.yaml file.
One slide on it will be added to the Quay technical deck.
Usage
The config app user is now given the option of two action logs storage options:
- Elasticsearch
- Database
If database if is selected, no additional configuration is needed (the current behavior).
If Elasticsearch is selected, various fields used to connect to the cluster that will be used should be filled. The AWS region can be left blank if it is not running on AWS.
A producer must also be selected:
- "Kinesis" will send the logs to an intermediate Kinesis stream on AWS, and it is up to the customer to setup the pipeline to send the logs from Kinesis to Elasticsearch (e.g Logstash)
- "Elasticsearch" will send the logs directly to the Elasticsearch, without an intermediate queue.
See attached images for more details.
- duplicates
-
PROJQUAY-290 Quay leverages the OCP built-in logging capabilities
- Planning
- is related to
-
PROJQUAY-331 ConfigTool Documentation changes for ElasticSearch, Builders
- Closed
-
PROJQUAY-389 PROJQUAY-113 QE Task: test case designing and acceptance testing
- Closed