Skip to content

Commit 578d543

Browse files
committed
feat(docs): update defaults in docs for kopia changes
1 parent b41aa0d commit 578d543

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

docs/usage/kopia/backends.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -729,19 +729,19 @@ VolSync's Kopia mover supports a comprehensive set of environment variables for
729729
**Logging Control Variables**
730730

731731
``KOPIA_FILE_LOG_LEVEL``
732-
Log level for file logs: debug, info, warn, error (default: warn)
732+
Log level for file logs: debug, info, warn, error (default: info)
733733

734734
``KOPIA_LOG_DIR_MAX_FILES``
735-
Maximum number of CLI log files to retain (default: 10)
735+
Maximum number of CLI log files to retain (default: 3)
736736

737737
``KOPIA_LOG_DIR_MAX_AGE``
738-
Maximum age of CLI log files, e.g., "24h", "7d" (default: 24h)
738+
Maximum age of CLI log files, e.g., "24h", "7d" (default: 4h)
739739

740740
``KOPIA_CONTENT_LOG_DIR_MAX_FILES``
741-
Maximum number of content log files to retain (default: 10)
741+
Maximum number of content log files to retain (default: 3)
742742

743743
``KOPIA_CONTENT_LOG_DIR_MAX_AGE``
744-
Maximum age of content log files (default: 24h)
744+
Maximum age of content log files (default: 4h)
745745

746746
.. note::
747747
**Logging Configuration**: VolSync provides optimized defaults for Kubernetes environments

docs/usage/kopia/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ to handle Kopia's temporary file requirements during restore operations.
7676

7777
**Logging Control**: VolSync provides fine-grained control over Kopia's file logging
7878
to prevent cache PVC filling issues. Default settings are optimized for Kubernetes
79-
with conservative log retention (warn level, 10 files, 24h retention).
79+
with minimal log retention (info level, 3 files, 4h retention) since external logging is typically used.
8080

8181
Getting Started
8282
===============

docs/usage/kopia/troubleshooting.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1438,20 +1438,20 @@ VolSync exposes Kopia's native logging controls through environment variables th
14381438
- Default
14391439
- Description
14401440
* - ``KOPIA_FILE_LOG_LEVEL``
1441-
- ``warn``
1442-
- Log level for file logs (debug, info, warn, error). Default changed from debug to reduce verbosity
1441+
- ``info``
1442+
- Log level for file logs (debug, info, warn, error). Provides good operational visibility without excessive verbosity
14431443
* - ``KOPIA_LOG_DIR_MAX_FILES``
1444-
- ``10``
1445-
- Maximum number of CLI log files to retain. Older files are automatically deleted
1444+
- ``3``
1445+
- Maximum number of CLI log files to retain. Optimized for Kubernetes where logs are externally collected
14461446
* - ``KOPIA_LOG_DIR_MAX_AGE``
1447-
- ``24h``
1448-
- Maximum age of CLI log files. Format: duration string (e.g., "24h", "7d", "168h")
1447+
- ``4h``
1448+
- Maximum age of CLI log files. Short retention since Kubernetes typically has external logging
14491449
* - ``KOPIA_CONTENT_LOG_DIR_MAX_FILES``
1450-
- ``10``
1451-
- Maximum number of content log files to retain (low-level formatting logs)
1450+
- ``3``
1451+
- Maximum number of content log files to retain. Minimal retention for immediate debugging only
14521452
* - ``KOPIA_CONTENT_LOG_DIR_MAX_AGE``
1453-
- ``24h``
1454-
- Maximum age of content log files. These logs don't contain sensitive data
1453+
- ``4h``
1454+
- Maximum age of content log files. Short retention optimized for Kubernetes environments
14551455
14561456
**Default Configuration Rationale**:
14571457
@@ -1593,7 +1593,7 @@ Best Practices for Logging in Kubernetes
15931593
15941594
1. **Use External Logging Systems**: Rely on Kubernetes pod logs and external aggregation (Loki, ElasticSearch, Splunk) rather than file logs.
15951595
1596-
2. **Conservative Defaults**: The VolSync defaults (warn level, 10 files, 24h retention) work well for most use cases.
1596+
2. **Conservative Defaults**: The VolSync defaults (info level, 3 files, 4h retention) are optimized for Kubernetes environments where external logging is typically used.
15971597
15981598
3. **Monitor Cache PVC Usage**: Set up alerts for cache PVC usage to catch issues early:
15991599
@@ -1681,9 +1681,9 @@ If you're experiencing cache PVC issues with existing deployments:
16811681
kubectl edit secret kopia-config -n <namespace>
16821682
16831683
# Add the logging configuration
1684-
# KOPIA_FILE_LOG_LEVEL: "warn"
1685-
# KOPIA_LOG_DIR_MAX_FILES: "10"
1686-
# KOPIA_LOG_DIR_MAX_AGE: "24h"
1684+
# KOPIA_FILE_LOG_LEVEL: "info"
1685+
# KOPIA_LOG_DIR_MAX_FILES: "3"
1686+
# KOPIA_LOG_DIR_MAX_AGE: "4h"
16871687
16881688
3. **Trigger New Backup**: Force a new backup to apply settings
16891689

0 commit comments

Comments
 (0)