Skip to content
Open
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
4 changes: 3 additions & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@ OpenShiftAsciiDoc.IdHasContextVariable = NO
OpenShiftAsciiDoc.NoTocInModules = NO
AsciiDocDITA.AttributeReference = NO
AsciiDoc.UnsetAttributes = NO
RedHat.PassiveVoice = NO
RedHat.PassiveVoice = YES
AsciiDocDITA.ConditionalCode = NO
AsciiDocDITA.ConceptLink = YES
AsciiDocDITA.RelatedLinks = YES

# Optional: pass doc attributes to asciidoctor before linting
# Temp values are used for Prow CI comment linting only
Expand Down
41 changes: 6 additions & 35 deletions .vale/styles/config/vocabularies/OpenShiftDocs/accept.txt
Original file line number Diff line number Diff line change
@@ -1,35 +1,6 @@
# Regex terms added to accept.txt are ignored by the Vale linter and override RedHat Vale rules.
# Add terms that have a corresponding incorrectly capitalized form to reject.txt.
[Ff]ronthaul
[Mm][Bb]ps
[Mm]idhaul
[Oo]n-premise
[Pp]assthrough
[Pp]ostinstall
[Pp]recaching
[Pp]reinstall
[Rr]ealtime
[Tt]elco
[Uu]npause
Assisted Installer
Control Plane Machine Set Operator
GHz
gpsd
gpspipe
hyperthreads?
KPIs?
linuxptp
Mellanox
MetalLB
NICs?
pmc
ubxtool
vDUs?
VFs?
Westport
MinIO
[Ii]ngesters?
[Qq]ueriers?
[Ff]rontends?
[Gg][Cc][Ss]
otel
Splunk
CloudWatch
datapoints
auditd
ovn
OVN
6 changes: 2 additions & 4 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Topics:
File: cluster-logging-support
- Name: Visualization for logging
File: logging-visualization
- Name: Quick start
File: quick-start
---
Name: Release notes
Dir: release_notes
Expand All @@ -34,10 +32,10 @@ Name: Configuring logging
Dir: configuring
Distros: openshift-logging
Topics:
- Name: Configuring log forwarding
File: configuring-log-forwarding
- Name: Configuring the logging collector
File: cluster-logging-collector
- Name: Configuring log forwarding
File: configuring-log-forwarding
- Name: Configuring the log store
File: configuring-the-log-store
- Name: Configuring LokiStack for OTLP
Expand Down
23 changes: 0 additions & 23 deletions about/quick-start.adoc

This file was deleted.

1 change: 0 additions & 1 deletion config/_attributes

This file was deleted.

81 changes: 0 additions & 81 deletions config/cluster-logging-configuring.adoc

This file was deleted.

19 changes: 0 additions & 19 deletions config/cluster-logging-memory.adoc

This file was deleted.

19 changes: 0 additions & 19 deletions config/cluster-logging-systemd.adoc

This file was deleted.

1 change: 0 additions & 1 deletion config/images

This file was deleted.

1 change: 0 additions & 1 deletion config/modules

This file was deleted.

1 change: 0 additions & 1 deletion config/snippets

This file was deleted.

19 changes: 12 additions & 7 deletions configuring/cluster-logging-collector.adoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
:_mod-docs-content-type: ASSEMBLY
:context: cluster-logging-collector
[id="cluster-logging-collector"]
= Configuring the logging collector
= Advanced collector configuration
include::_attributes/common-attributes.adoc[]

toc::[]

{logging-title-uc} collects operations and application logs from your cluster and enriches the data with Kubernetes pod and project metadata.
All supported modifications to the log collector can be performed though the `spec.collection` stanza in the `ClusterLogForwarder` custom resource (CR).

include::modules/creating-logfilesmetricexporter.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]
This section covers advanced collector configuration options, including input sources and receivers, pod rollout strategy, and network policies. For basic collector setup, see "Configuring log forwarding."

[id="cluster-logging-collector-input-receivers"]
== Configuring input receivers

The {clo} deploys a service for each configured input receiver so that clients can write to the collector. This service exposes the port specified for the input receiver. For log forwarder `ClusterLogForwarder` CR deployments, the service name is in the `<clusterlogforwarder_resource_name>-<input_name>` format.

[NOTE]
====
There are only two supported use cases for input receivers:

* Receiving audit API events from the API server
* Receiving journal logs over syslog from OpenStack
====

include::modules/configuring-the-collector-to-receive-audit-logs-as-an-http-server.adoc[leveloffset=+2]
include::modules/configuring-the-collector-to-listen-for-connections-as-a-syslog-server.adoc[leveloffset=+2]

include::modules/configuring-pod-rollout-strategy.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]

[id="network_policies-to-override-restrictive-network-in-a-cluster_{context}"]
== Network policies to override restrictive network in a cluster

Expand Down
Loading