1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/modules/cluster-logging-vector-tech-preview.adoc

69 lines
1.8 KiB
Plaintext

// Module included in the following assemblies:
//cluster-logging-release-notes.adoc
:_content-type: PROCEDURE
[id="cluster-logging-vector-tech-preview_{context}"]
:FeatureName: Vector
include::snippets/technology-preview.adoc[]
[id="cluster-logging-about-vector"]
= About Vector
Vector is a log collector offered as a tech-preview alternative to the current default collector for the {logging}.
The following outputs are supported:
* `elasticsearch`. An external Elasticsearch instance. The `elasticsearch` output can use a TLS connection.
* `kafka`. A Kafka broker. The `kafka` output can use an unsecured or TLS connection.
* `loki`. Loki, a horizontally scalable, highly available, multi-tenant log aggregation system.
[id="cluster-logging-enabling-vector"]
== Enabling Vector
Vector is not enabled by default. Use the following steps to enable Vector on your {product-title} cluster.
[IMPORTANT]
====
Vector does not support FIPS Enabled Clusters.
====
.Prerequisites
* {product-title}: 4.11
* {logging-title-uc}: 5.4
* FIPS disabled
.Procedure
. Edit the `ClusterLogging` custom resource (CR) in the `openshift-logging` project:
+
[source,terminal]
----
$ oc -n openshift-logging edit ClusterLogging instance
----
. Add a `logging.openshift.io/preview-vector-collector: enabled` annotation to the `ClusterLogging` custom resource (CR).
. Add `vector` as a collection type to the `ClusterLogging` custom resource (CR).
[source,yaml]
----
apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
name: "instance"
namespace: "openshift-logging"
annotations:
logging.openshift.io/preview-vector-collector: enabled
spec:
collection:
logs:
type: "vector"
vector: {}
----
[role="_additional-resources"]
.Additional resources
* link:https://vector.dev/docs/about/what-is-vector/[Vector Documentation]