Skip to content

Commit 29d1446

Browse files
authored
Merge pull request #64641 from abrennan89/OBSDOCS-498
OBSDOCS-498: Fixes for major customer portal breakage
2 parents 35d5e36 + 0c9f10e commit 29d1446

26 files changed

+139
-270
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2545,10 +2545,6 @@ Topics:
25452545
Topics:
25462546
- Name: Logging 5.7 Release Notes
25472547
File: logging-5-7-release-notes
2548-
- Name: Getting started with logging
2549-
File: logging-5-7-getting-started
2550-
- Name: Understanding Logging
2551-
File: logging-5-7-architecture
25522548
- Name: Configuring Logging
25532549
File: logging-5-7-configuration
25542550
- Name: Administering Logging
@@ -2561,10 +2557,6 @@ Topics:
25612557
Topics:
25622558
- Name: Logging 5.6 Release Notes
25632559
File: logging-5-6-release-notes
2564-
- Name: Getting started with logging
2565-
File: logging-5-6-getting-started
2566-
- Name: Understanding Logging
2567-
File: logging-5-6-architecture
25682560
- Name: Configuring Logging
25692561
File: logging-5-6-configuration
25702562
- Name: Administering Logging
@@ -2577,10 +2569,6 @@ Topics:
25772569
Topics:
25782570
- Name: Logging 5.5 Release Notes
25792571
File: logging-5-5-release-notes
2580-
- Name: Getting started with logging
2581-
File: logging-5-5-getting-started
2582-
- Name: Understanding Logging
2583-
File: logging-5-5-architecture
25842572
- Name: Administering Logging
25852573
File: logging-5-5-administration
25862574
# - Name: Configuring Logging

logging/.meta-logging-quickref.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ Files referenced only apply to versions 5.5+ of logging.
1919

2020
.Include syntax:
2121
----
22-
\include::target[leveloffset=offset,lines=ranges]
23-
\include::modules/logging-module-name.adoc[leveloffset=+1,lines=5..10]
22+
\include::modules/logging-module-name.adoc[leveloffset=+1]
2423
\include::snippets/
2524
----
2625

@@ -36,11 +35,9 @@ Files referenced only apply to versions 5.5+ of logging.
3635

3736
* Snippets
3837
** logging-stable-updates-snip.adoc[]
39-
** logging-log-types-snip.adoc[]
4038
** logging-compatibility-snip.adoc[]
4139
** logging-loki-vs-lokistack-snip.adoc[]
4240
** logging-create-secret-snip.adoc[]
4341
** logging-supported-config-snip.adoc[]
4442
** logging-approval-strategy-snip.adoc[]
4543
** logging-subscription-object-snip.adoc[
46-
** logging-create-apply-cr-snip.adoc[]

logging/cluster-logging-deploying.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99

1010
You can install the {logging-title} by deploying the OpenShift Elasticsearch and Red Hat OpenShift Logging Operators. The OpenShift Elasticsearch Operator creates and manages the Elasticsearch cluster used by OpenShift Logging. The {logging} Operator creates and manages the components of the logging stack.
1111

12-
The process for deploying the {logging} to {product-title}
12+
The process for deploying the {logging} to {product-title}
1313
ifdef::openshift-rosa[]
1414
(ROSA)
1515
endif::[]
@@ -19,10 +19,13 @@ endif::[]
1919
2020
* Installing the logging subsystem for {product-title} using xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[the web console] or xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-cli_cluster-logging-deploying[the CLI].
2121
22-
// The following include statements pull in the module files that comprise
23-
// the assembly. Include any combination of concept, procedure, or reference
24-
// modules required to cover the user story. You can also include other
25-
// assemblies.
22+
[IMPORTANT]
23+
====
24+
For new installations, Vector and LokiStack are recommended. Documentation for logging is in the process of being updated to reflect these underlying component changes.
25+
====
26+
27+
include::snippets/logging-elastic-dep-snip.adoc[]
28+
include::snippets/logging-fluentd-dep-snip.adoc[]
2629

2730
include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1]
2831

logging/cluster-logging-external.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-5.
3434

3535
include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-6.adoc[leveloffset=+1]
3636

37+
include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-7.adoc[leveloffset=+1]
38+
3739
include::modules/cluster-logging-collector-log-forward-es.adoc[leveloffset=+1]
3840

3941
include::modules/cluster-logging-collector-log-forward-fluentd.adoc[leveloffset=+1]

logging/cluster-logging.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,14 @@ toc::[]
1010
ifdef::openshift-enterprise,openshift-rosa,openshift-dedicated,openshift-webscale,openshift-origin[]
1111
As a cluster administrator, you can deploy the {logging} to aggregate all the logs from your {product-title} cluster, such as node system audit logs, application container logs, and infrastructure logs. The {logging} aggregates these logs from throughout your cluster and stores them in a default log store. You can xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[use the Kibana web console to visualize log data].
1212

13-
The {logging} aggregates the following types of logs:
14-
15-
* `application` - Container logs generated by user applications running in the cluster, except infrastructure container applications.
16-
* `infrastructure` - Logs generated by infrastructure components running in the cluster and {product-title} nodes, such as journal logs. Infrastructure components are pods that run in the `openshift*`, `kube*`, or `default` projects.
17-
* `audit` - Logs generated by auditd, the node audit system, which are stored in the */var/log/audit/audit.log* file, and the audit logs from the Kubernetes apiserver and the OpenShift apiserver.
18-
1913
[NOTE]
2014
====
2115
Because the internal {product-title} Elasticsearch log store does not provide secure storage for audit logs, audit logs are not stored in the internal Elasticsearch instance by default. If you want to send the audit logs to the default internal Elasticsearch log store, for example to view the audit logs in Kibana, you must use the Log Forwarding API as described in xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-elasticsearch-audit_cluster-logging-store[Forward audit logs to the log store].
2216
====
2317
endif::[]
2418

19+
include::modules/logging-architecture-overview.adoc[leveloffset=+1]
20+
2521
ifdef::openshift-rosa,openshift-dedicated[]
2622
include::modules/cluster-logging-cloudwatch.adoc[leveloffset=+1]
2723
.Next steps

logging/v5_5/logging-5-5-architecture.adoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

logging/v5_5/logging-5-5-getting-started.adoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

logging/v5_6/logging-5-6-architecture.adoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

logging/v5_6/logging-5-6-getting-started.adoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

logging/v5_7/logging-5-7-architecture.adoc

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)