K8SPXC-1789 Added log rotation documentation#305
Open
nastena1606 wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for log rotation in the Percona Operator for MySQL docs, and wires it into the site navigation alongside the Custom Resource options reference.
Changes:
- Added a new
docs/log-rotation.mdpage describing how to configure logrotate (schedule, full override, and extra ConfigMap rules). - Updated
mkdocs-base.ymlnavigation to include the new “Log rotation” page under “Logging”. - Extended
docs/operator.mdCR options reference withlogcollector.logRotate.*fields.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| mkdocs-base.yml | Adds “Log rotation” to the MkDocs nav under Logging. |
| docs/operator.md | Documents new logcollector.logRotate.* CR keys. |
| docs/log-rotation.md | New how-to page for configuring log rotation behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| For example, the following ConfigMap adds separate rotation rules for Galera-related logs (`GRA_*.log`) and for audit logs (`audit.log`) with different rotation and compression settings. | ||
|
|
||
| 1. Create a ConfigMap configuration file. For example, `custom-logrotate.yaml` . Specify additional rules: |
|
|
||
| ### `logcollector.logRotate.schedule` | ||
|
|
||
| Cron expression for the logrotate schedule (default: 0 0 0 ** *). |
|
|
||
| !!! important | ||
|
|
||
| You must provide the full `logrotate` configuration because the Operator replaces the default configuration with the one you provide. Refer to the [default configuration](https://github.com/percona/percona-xtradb-cluster-operator/v{{release}}/build/logcollector/logrotate/logrotate-mysql.conf) to see the built-in logrotate rules and use it as a guide for your custom settings. |
Updated navigation to include this topic Updated CR reference
nastena1606
force-pushed
the
K8SPXC-1789-Doc-logrotate-setup
branch
from
b698af3 to
2c92dd5
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for configuring log rotation in the Percona Operator for MySQL docs, and wires the new page into the site navigation while updating the CR options reference.
Changes:
- Adds a new
Log rotationdocumentation page with configuration examples. - Updates the MkDocs navigation to include the new page under Configuration → Logging.
- Extends the CR reference (
docs/operator.md) withlogcollector.logRotate.*options.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
mkdocs-base.yml |
Adds Log rotation to the Logging nav section. |
docs/operator.md |
Documents new logcollector.logRotate.* CR fields. |
docs/log-rotation.md |
New guide explaining scheduling, overriding, and extending logrotate config. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+27
to
+36
| 1. Edit the `deploy/cr.yaml` Custom Resource manifest. Set the log rotation schedule in [cron format](https://en.wikipedia.org/wiki/Cron) using the `spec.logcollector.logRotate.schedule` option. | ||
|
|
||
| This example runs log rotation every 6 hours: | ||
|
|
||
| ```yaml | ||
| spec: | ||
| logcollector: | ||
| logRotate: | ||
| schedule: "0 */6 * * *" | ||
| ``` |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
mayankshah1607,
nmarukovich,
pooknull and
valmiranogueira
as code owners
mayankshah1607
approved these changes
Apr 30, 2026
egegunes
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated navigation to include this topic
Updated CR reference