Bug 1622044 - [DOCS] auditFilePath value is set to wrong path
Summary: [DOCS] auditFilePath value is set to wrong path
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.10.0
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
: ---
Assignee: Andrew Taylor
QA Contact: Gaoyun Pei
Vikram Goyal
URL:
Whiteboard:
: 1565555 1636266 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-08-24 09:19 UTC by Suresh
Modified: 2022-03-13 15:27 UTC (History)
11 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-04-03 14:09:55 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Gitlab 9746 0 None None None 2018-10-16 12:24:50 UTC
Red Hat Bugzilla 1615798 0 low CLOSED [DOCS] audit log special mount path should be noted in doc 2021-02-22 00:41:40 UTC
Red Hat Knowledge Base (Solution) 3589691 0 None None None 2018-08-29 02:50:42 UTC
Red Hat Knowledge Base (Solution) 3597851 0 None None None 2018-12-17 21:44:14 UTC

Internal Links: 1615798

Description Suresh 2018-08-24 09:19:21 UTC
Document URL: 
https://docs.openshift.com/container-platform/3.10/install_config/master_node_configuration.html#master-node-config-audit-config


Inside "Advanced Setup for the Audit Log", the auditFilePath is set to /var/log/openpaas-oscp-audit/openpaas-oscp-audit.log",

openshift_master_audit_config={"enabled": true, "auditFilePath": "/var/log/openpaas-oscp-audit/openpaas-oscp-audit.log", "maximumFileRetentionDays": 14, "maximumFileSizeMegabytes": 500, "maximumRetainedFiles": 5}


In 3.10, this path should be inside /var/lib/origin


Additional information: 

Reference: https://bugzilla.redhat.com/show_bug.cgi?id=1589063



Inside "Advanced Setup for the Audit Log", the auditFilePath is set to /var/log/openpaas-oscp-audit/openpaas-oscp-audit.log",

openshift_master_audit_config={"enabled": true, "auditFilePath": "/var/lib/origin/openpaas-oscp-audit/openpaas-oscp-audit.log", "maximumFileRetentionDays": 14, "maximumFileSizeMegabytes": 500, "maximumRetainedFiles": 5}

Comment 1 Steven Walter 2018-10-05 19:20:36 UTC

When trying to run with something outside of the new required locations (as the current examples tell you to), you'll get:


  1. Hosts:    10.10.92.127
     Play:     Retrieve existing master configs and validate
     Task:     Check for file paths outside of /etc/origin/master in master's config
     Message:  A string value that appears to be a file path located outside of
               /etc/origin/master/, /var/lib/origin, /etc/origin/cloudprovider, /etc/origin/kubelet-plugins, /usr/libexec/kubernetes/kubelet-plugins has been found in /etc/origin/master/master-config.yaml.
               In 3.10 and newer, all files needed by the master must reside inside of
               those directories or a subdirectory or it will not be readable by the
               master process. Please migrate all files needed by the master into
               one of /etc/origin/master/, /var/lib/origin, /etc/origin/cloudprovider, /etc/origin/kubelet-plugins, /usr/libexec/kubernetes/kubelet-plugins or a subdirectory and update your master configs before
               proceeding. The string found was: /var/log/audit.log
               ***********************
               NOTE: the following items do not need to be migrated, they will be migrated
               for you: oauthConfig.identityProviders

Comment 2 mmariyan 2018-10-16 12:24:50 UTC
the upstream issue raised here.

 https://github.com/openshift/openshift-ansible/issues/9746

Comment 3 Kathryn Alexander 2018-10-24 18:17:10 UTC
PR's here: https://github.com/openshift/openshift-docs/pull/12630

Jianlin, will you PTAL?

Comment 4 Gaoyun Pei 2018-10-25 07:34:42 UTC
lgtm, openshift_master_audit_config={"enabled": true, "auditFilePath": "/var/lib/origin/openpaas-oscp-audit.log", "maximumFileRetentionDays": 14, "maximumFileSizeMegabytes": 500, "maximumRetainedFiles": 5} works well in ocp-3.11 installation.

Comment 6 Kathryn Alexander 2018-10-25 15:33:54 UTC
Thank you Gaoyun! I'm merging the PR and will wait for it to go live.

Comment 9 Scott Dodson 2018-12-04 21:17:07 UTC
*** Bug 1636266 has been marked as a duplicate of this bug. ***

Comment 10 Maciej Szulik 2018-12-17 21:44:15 UTC
*** Bug 1565555 has been marked as a duplicate of this bug. ***

Comment 12 Andrew Taylor 2019-01-30 17:12:34 UTC
Pull request created: https://github.com/openshift/openshift-docs/pull/13477

Gaoyun Pei, please take a look.

Thank you,
Andrew

Comment 13 Gaoyun Pei 2019-01-31 00:46:56 UTC
PR lgtm, move bug to verified.

Comment 14 openshift-github-bot 2019-01-31 14:59:09 UTC
Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/d5dddb34e5b6550ae78419a403c4b644f2e5a2ff
bug 1622044 corrected auditFilePath examples

https://github.com/openshift/openshift-docs/commit/52289913572c077e763901cf222fa809dc7865d3
Merge pull request #13477 from sheriff-rh/bz1622044

bug 1622044 corrected auditFilePath examples

Comment 15 Andrew Taylor 2019-01-31 15:01:44 UTC
Merged; setting release pending.

Comment 21 Andrew Taylor 2019-03-12 13:26:33 UTC
auditFileLog changed to /var/lib/origin/audit-ocp.log again, as were originally merged in #14. 

Changes have been committed and merged to 3.10+: 

https://github.com/openshift/openshift-docs/pull/14063
https://github.com/openshift/openshift-docs/pull/14064
https://github.com/openshift/openshift-docs/pull/14065


Setting release pending.


Note You need to log in before you can comment on or make changes to this bug.