Skip to content

Commit 0da0032

Browse files
authored
Merge pull request #66749 from abrennan89/OBSDOCS-594
OBSDOCS-594 + OBSDOCS-567: Logging upgrading docs and mCLF note
2 parents 7f4fafe + d7cd953 commit 0da0032

13 files changed

+247
-363
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2536,6 +2536,8 @@ Topics:
25362536
File: cluster-logging
25372537
- Name: Installing Logging
25382538
File: cluster-logging-deploying
2539+
- Name: Updating Logging
2540+
File: cluster-logging-upgrading
25392541
Distros: openshift-enterprise,openshift-origin
25402542
- Name: Configuring your Logging deployment
25412543
Dir: config
@@ -2577,8 +2579,6 @@ Topics:
25772579
File: cluster-logging-collector
25782580
- Name: Collecting and storing Kubernetes events
25792581
File: cluster-logging-eventrouter
2580-
- Name: Updating Logging
2581-
File: cluster-logging-upgrading
25822582
- Name: Viewing cluster dashboards
25832583
File: cluster-logging-dashboards
25842584
- Name: Logging alerts

_topic_maps/_topic_map_osd.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Topics:
143143
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
144144
# - Name: Importing simple content access entitlements with Insights Operator
145145
# File: insights-operator-simple-access
146-
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
146+
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
147147
# - Name: Gathering data about your cluster
148148
# File: gathering-cluster-data
149149
# Distros: openshift-dedicated
@@ -165,7 +165,7 @@ Topics:
165165
# - Name: Troubleshooting operating system issues
166166
# File: troubleshooting-operating-system-issues
167167
# Distros: openshift-dedicated
168-
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
168+
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
169169
# - Name: Troubleshooting network issues
170170
# File: troubleshooting-network-issues
171171
# Distros: openshift-dedicated
@@ -858,6 +858,8 @@ Topics:
858858
File: cluster-logging
859859
- Name: Installing Logging
860860
File: cluster-logging-deploying
861+
- Name: Updating Logging
862+
File: cluster-logging-upgrading
861863
- Name: Accessing the service logs
862864
File: sd-accessing-the-service-logs
863865
- Name: Configuring your Logging deployment
@@ -899,8 +901,6 @@ Topics:
899901
File: cluster-logging-collector
900902
- Name: Collecting and storing Kubernetes events
901903
File: cluster-logging-eventrouter
902-
- Name: Updating Logging
903-
File: cluster-logging-upgrading
904904
- Name: Viewing cluster dashboards
905905
File: cluster-logging-dashboards
906906
- Name: Logging alerts

_topic_maps/_topic_map_rosa.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ Topics:
242242
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
243243
# - Name: Importing simple content access entitlements with Insights Operator
244244
# File: insights-operator-simple-access
245-
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
245+
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
246246
# - Name: Gathering data about your cluster
247247
# File: gathering-cluster-data
248248
# Distros: openshift-rosa
@@ -267,7 +267,7 @@ Topics:
267267
# - Name: Troubleshooting operating system issues
268268
# File: troubleshooting-operating-system-issues
269269
# Distros: openshift-rosa
270-
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
270+
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
271271
# - Name: Troubleshooting network issues
272272
# File: troubleshooting-network-issues
273273
# Distros: openshift-rosa
@@ -1029,6 +1029,8 @@ Topics:
10291029
File: cluster-logging
10301030
- Name: Installing Logging
10311031
File: cluster-logging-deploying
1032+
- Name: Updating Logging
1033+
File: cluster-logging-upgrading
10321034
- Name: Accessing the service logs
10331035
File: sd-accessing-the-service-logs
10341036
- Name: Viewing cluster logs in the AWS Console
@@ -1071,8 +1073,6 @@ Topics:
10711073
File: cluster-logging-collector
10721074
- Name: Collecting and storing Kubernetes events
10731075
File: cluster-logging-eventrouter
1074-
- Name: Updating Logging
1075-
File: cluster-logging-upgrading
10761076
- Name: Viewing cluster dashboards
10771077
File: cluster-logging-dashboards
10781078
- Name: Logging alerts
Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
:_mod-docs-content-type: ASSEMBLY
22
:context: cluster-logging-upgrading
33
[id="cluster-logging-upgrading"]
4-
= Updating OpenShift Logging
4+
= Updating Logging
55
include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
[id="cluster-logging-supported-versions"]
10-
== Supported Versions
11-
For version compatibility and support information, see link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy]
9+
There are two types of {logging} updates: minor release updates (5.y.z) and major release updates (5.y).
1210

13-
To upgrade from cluster logging in {product-title} version 4.6 and earlier to OpenShift Logging 5.x, you update the {product-title} cluster to version 4.7 or 4.8. Then, you update the following operators:
11+
[id="cluster-logging-upgrading-minor"]
12+
== Minor release updates
1413

15-
* From Elasticsearch Operator 4.x to OpenShift Elasticsearch Operator 5.x
16-
* From Cluster Logging Operator 4.x to Red Hat OpenShift Logging Operator 5.x
14+
If you installed the {logging} Operators using the *Automatic* update approval option, your Operators receive minor version updates automatically. You do not need to complete any manual update steps.
1715

18-
To upgrade from a previous version of OpenShift Logging to the current version, you update OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator to their current versions.
16+
If you installed the {logging} Operators using the *Manual* update approval option, you must manually approve minor version updates. For more information, see xref:../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update].
1917

20-
include::modules/cluster-logging-updating-logging-to-current.adoc[leveloffset=+1]
18+
[id="cluster-logging-upgrading-major"]
19+
== Major release updates
20+
21+
For major version updates you must complete some manual steps.
22+
23+
For major release version compatibility and support information, see link:https://access.redhat.com/support/policy/updates/openshift_operators#platform-agnostic[OpenShift Operator Life Cycles].
24+
25+
include::modules/logging-operator-upgrading-all-ns.adoc[leveloffset=+1]
26+
27+
include::modules/logging-upgrading-clo.adoc[leveloffset=+1]
28+
29+
include::modules/logging-upgrading-loki.adoc[leveloffset=+1]
30+
31+
include::modules/cluster-logging-upgrading-elasticsearch.adoc[leveloffset=+1]

logging/log_collection_forwarding/log-forwarding.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,17 @@ Administrators can create `ClusterLogForwarder` resources that specify which log
2626

2727
Administrators can also authorize RBAC permissions that define which service accounts and users can access and forward which types of logs.
2828

29-
////
30-
include::modules/log-forwarding-modes.adoc[leveloffset=+1]
29+
include::modules/log-forwarding-implementations.adoc[leveloffset=+1]
3130

32-
[id="log-forwarding-enabling-multi-clf-mode"]
33-
== Enabling multi log forwarder mode for a cluster
31+
[id="log-forwarding-enabling-multi-clf-feature"]
32+
== Enabling the multi log forwarder feature for a cluster
3433

35-
To use multi log forwarder mode, you must create a service account and cluster role bindings for that service account. You can then reference the service account in the `ClusterLogForwarder` resource to control access permissions.
34+
To use the multi log forwarder feature, you must create a service account and cluster role bindings for that service account. You can then reference the service account in the `ClusterLogForwarder` resource to control access permissions.
35+
36+
[IMPORTANT]
37+
====
38+
In order to support multi log forwarding in additional namespaces other than the `openshift-logging` namespace, you must xref:../../logging/cluster-logging-upgrading.adoc#logging-operator-upgrading-all-ns_cluster-logging-upgrading[update the Cluster Logging Operator to watch all namespaces]. This functionality is supported by default in new Cluster Logging Operator version 5.8 installations.
39+
====
3640

3741
include::modules/log-collection-rbac-permissions.adoc[leveloffset=+2]
3842

@@ -45,7 +49,6 @@ endif::[]
4549
* link:https://kubernetes.io/docs/reference/access-authn-authz/rbac/[Using RBAC Authorization Kubernetes documentation]
4650

4751
include::modules/logging-create-clf.adoc[leveloffset=+1]
48-
////
4952

5053
[id="log-forwarding-audit-logs"]
5154
== Sending audit logs to the internal log store

modules/cluster-logging-updating-logging-to-5-0.adoc

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

0 commit comments

Comments
 (0)