Skip to content

Commit

Permalink
[Docs] Update logging.files.permissions documentation to consider uma…
Browse files Browse the repository at this point in the history
…sk (#20584) (#28347)

Changes implemented in the (#14119) made all Beats-created files and folders apply an umask of 0027 (on POSIX systems).

Co-authored-by: dplavcic <dplavcic@users.noreply.github.com>
  • Loading branch information
dplavcic and dplavcic authored Dec 17, 2021
1 parent 3e852fb commit ecd68db
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
6 changes: 3 additions & 3 deletions filebeat/docs/filebeat-general-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ That means in case there are some states where the TTL expired, these are only r
The permissions mask to apply on registry data file. The default value is 0600. The permissions option must be a valid Unix-style file permissions mask expressed in octal notation. In Go, numbers in octal notation must start with 0.

The most permissive mask allowed is 0640. If a higher permissions mask is
specified via this setting, it will be subject to a umask of 0027.
specified via this setting, it will be subject to an umask of 0027.

This option is not supported on Windows.

Examples:

0640: give read and write access to the file owner, and read access to members of the group associated with the file.
0600: give read and write access to the file owner, and no access to all others.
* 0640: give read and write access to the file owner, and read access to members of the group associated with the file.
* 0600: give read and write access to the file owner, and no access to all others.

[source,yaml]
-------------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion filebeat/docs/howto/override-config-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ logging.files:
path: /var/log/filebeat
name: filebeat
keepfiles: 7
permissions: 0644
permissions: 0640
----

To override the logging level and send logging output to standard error instead
Expand Down
13 changes: 8 additions & 5 deletions libbeat/docs/loggingconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ logging.files:
path: /var/log/{beatname_lc}
name: {beatname_lc}
keepfiles: 7
permissions: 0644
permissions: 0640
----
endif::win_only[]

Expand All @@ -45,7 +45,7 @@ logging.files:
path: C:{backslash}ProgramData{backslash}{beatname_lc}{backslash}Logs
name: {beatname_lc}
keepfiles: 7
permissions: 0644
permissions: 0640
----
endif::win_only[]

Expand Down Expand Up @@ -231,12 +231,15 @@ The permissions mask to apply when rotating log files. The default value is
expressed in octal notation. In Go, numbers in octal notation must start with
'0'.

The most permissive mask allowed is 0640. If a higher permissions mask is
specified via this setting, it will be subject to an umask of 0027.

This option is not supported on Windows.

Examples:

* 0644: give read and write access to the file owner, and read access to all others.
* 0640: give read and write access to the file owner, and read access to members of the group associated with the file.
* 0600: give read and write access to the file owner, and no access to all others.
* 0664: give read and write access to the file owner and members of the group
associated with the file, as well as read access to all other users.

[float]
==== `logging.files.interval`
Expand Down

0 comments on commit ecd68db

Please sign in to comment.