Skip to content

Commit 0fc3baa

Browse files
authored
Merge pull request #75292 from michaelryanmcneill/OSDOCS-10398
OSDOCS-10398: updating docs to reflect the use of oc adm node-logs is allowed
2 parents 08ab308 + b920842 commit 0fc3baa

File tree

5 files changed

+24
-13
lines changed

5 files changed

+24
-13
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ Name: Security and compliance
367367
Dir: security
368368
Distros: openshift-dedicated
369369
Topics:
370-
- Name: Audit logs
370+
- Name: Viewing audit logs
371371
File: audit-log-view
372372
---
373373
Name: Authentication and authorization

_topic_maps/_topic_map_rosa.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ Name: Security and compliance
590590
Dir: security
591591
Distros: openshift-rosa
592592
Topics:
593-
- Name: Audit logs
593+
- Name: Viewing audit logs
594594
File: audit-log-view
595595
- Name: Adding additional constraints for IP-based AWS role assumption
596596
File: rosa-adding-additional-constraints-for-ip-based-aws-role-assumption

modules/gathering-data-audit-logs.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@ You can gather audit logs, which are a security-relevant chronological set of re
2424
2525
endif::support[]
2626
ifdef::viewing[]
27+
2728
You can use the must-gather tool to collect the audit logs for debugging your cluster, which you can review or send to Red Hat Support.
29+
30+
ifdef::openshift-dedicated[]
31+
[NOTE]
32+
====
33+
In {product-title} deployments, customers who are not using the Customer Cloud Subscription (CCS) model must request a copy of your cluster's audit logs by contacting Red Hat Support. This is because using the must-gather tool requires `cluster-admin` privileges.
34+
====
35+
endif::openshift-dedicated[]
2836
endif::viewing[]
2937

3038
.Procedure

modules/nodes-nodes-audit-log-basic-viewing.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88

99
You can view the logs for the OpenShift API server, Kubernetes API server, OpenShift OAuth API server, and OpenShift OAuth server for each control plane node.
1010

11+
ifdef::openshift-dedicated[]
12+
[NOTE]
13+
====
14+
In {product-title} deployments, customers who are not using the Customer Cloud Subscription (CCS) model must request a copy of your cluster's audit logs by contacting Red Hat Support. This is because viewing API server audit logs requires `cluster-admin` privileges.
15+
====
16+
endif::openshift-dedicated[]
17+
1118
.Procedure
1219

1320
To view the audit logs:

security/audit-log-view.adoc

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
:_mod-docs-content-type: ASSEMBLY
22
include::_attributes/common-attributes.adoc[]
3-
ifndef::openshift-rosa,openshift-dedicated[]
4-
[id="audit-log-view"]
5-
= Viewing audit logs
6-
endif::openshift-rosa,openshift-dedicated[]
7-
83
ifdef::openshift-rosa,openshift-dedicated[]
94
include::_attributes/attributes-openshift-dedicated.adoc[]
10-
[id="audit-log-view"]
11-
= Audit logs
125
endif::openshift-rosa,openshift-dedicated[]
6+
7+
[id="audit-log-view"]
8+
= Viewing audit logs
139
:context: audit-log-view
1410

1511
toc::[]
@@ -18,23 +14,23 @@ toc::[]
1814

1915
include::modules/nodes-nodes-audit-log-basic.adoc[leveloffset=+1]
2016

21-
ifndef::openshift-rosa,openshift-dedicated[]
2217
// Viewing the audit log
2318
include::modules/nodes-nodes-audit-log-basic-viewing.adoc[leveloffset=+1]
2419

2520
// Filtering audit logs
2621
include::modules/security-audit-log-filtering.adoc[leveloffset=+1]
27-
endif::openshift-rosa,openshift-dedicated[]
22+
2823
// Gathering audit logs
2924
include::modules/gathering-data-audit-logs.adoc[leveloffset=+1]
3025

31-
ifndef::openshift-rosa,openshift-dedicated[]
3226
[id="viewing-audit-logs-additional-resources"]
3327
[role="_additional-resources"]
3428
== Additional resources
3529

30+
ifndef::openshift-rosa,openshift-dedicated[]
3631
* xref:../support/gathering-cluster-data.adoc#about-must-gather_gathering-cluster-data[Must-gather tool]
3732
* link:https://github.com/kubernetes/apiserver/blob/master/pkg/apis/audit/v1/types.go#L72[API audit log event structure]
3833
* xref:../security/audit-log-policy-config.adoc#audit-log-policy-config[Configuring the audit log policy]
39-
* xref:../observability/logging/log_collection_forwarding/log-forwarding.adoc#log-forwarding[About log forwarding]
4034
endif::[]
35+
* xref:../observability/logging/log_collection_forwarding/log-forwarding.adoc#log-forwarding[About log forwarding]
36+

0 commit comments

Comments
 (0)