Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions modules/cluster-logging-about-vector.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Module included in the following assemblies:
//cluster-logging-release-notes.adoc

:_content-type: CONCEPT
[id="cluster-logging-about-vector_{context}"]
:FeatureName: Vector
include::snippets/technology-preview.adoc[]

= About Vector
[role="_abstract"]
Vector is an observability data pipeline currently offered as an alternative to the default collector for the {logging}.

[IMPORTANT]
====
Vector does not support FIPS Enabled Clusters.
====

The following outputs are supported:

--
* `cloudwatch`. Amazon CloudWatch, a monitoring and log storage service hosted by Amazon Web Services (AWS).

* `elasticsearch`. An external Elasticsearch instance. The `elasticsearch` output can use a TLS connection.

* `fluentdForward`. An external log aggregation solution that supports Fluentd. This option uses the Fluentd *forward* protocols. The `fluentForward` output can use a TCP or TLS connection and supports shared-key authentication by providing a *shared_key* field in a secret. Shared-key authentication can be used with or without TLS.

* `kafka`. A Kafka broker. The `kafka` output can use a TCP or TLS connection.

* `loki`. Loki, a horizontally scalable, highly available, multi-tenant log aggregation system.

* `syslog`. An external log aggregation solution that supports the syslog link:https://tools.ietf.org/html/rfc3164[RFC3164] or link:https://tools.ietf.org/html/rfc5424[RFC5424] protocols. The `syslog` output can use a UDP, TCP, or TLS connection.


[role="_additional-resources"]
.Additional resources
* link:https://vector.dev/docs/about/what-is-vector/[Vector Documentation]
89 changes: 89 additions & 0 deletions modules/cluster-logging-enabling-vector.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
// Module included in the following assemblies:
//cluster-logging-release-notes.adoc

:_content-type: PROCEDURE
[id="cluster-logging-enabling-vector_{context}"]
:FeatureName: Vector
include::snippets/technology-preview.adoc[]

= Enabling Vector

[role="_abstract"]
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.10
* {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 `logging.openshift.io/preview-vector-collector: enabled` to the `ClusterLogging` custom resource (CR).

[source,yaml]
----
apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
name: "instance"
namespace: "openshift-logging"
spec:
managementState: "Managed"
logStore:
type: "elasticsearch"
retentionPolicy:
application:
maxAge: 1d
infra:
maxAge: 7d
audit:
maxAge: 7d
elasticsearch:
nodeCount: 3
resources:
limits:
memory: 16Gi
requests:
cpu: "1"
memory: 16Gi
storage:
storageClassName: "gp2"
size: "200G"
redundancyPolicy: "SingleRedundancy"
visualization:
type: "kibana"
kibana:
resources:
limits:
memory: 736Mi
requests:
cpu: 100m
memory: 736Mi
replicas: 1
collection:
logs:
type: "fluentd"
fluentd:
resources:
limits:
memory: 736Mi
requests:
cpu: 100m
memory: 736Mi
logging.openshift.io/preview-vector-collector: enabled
----

.