ConfigMap Preservation During Upgrades¶
During CNF upgrades, certain ConfigMaps contain user-specific configurations and environment settings that must be preserved. The upgrade feature implements intelligent ConfigMap preservation strategies to maintain your customizations while incorporating new features and fixes from F5 releases.
How ConfigMap Preservation Works¶
The ConfigMap preservation feature automatically maintains your custom configurations throughout CNF upgrades. When you upgrade your CNF deployment, the system:
Retrieves existing ConfigMap settings from your cluster.
Preserves your custom configurations and environment-specific settings.
Incorporates new F5 features and fixes without overwriting your customizations.
Eliminates the need to manually back up and restore configurations.
This ensures your customizations remain intact while you gain access to the latest CNF improvements.
Supported ConfigMaps¶
The following ConfigMaps have preservation support during upgrades:
TMM ConfigMaps¶
TMM ConfigMaps preserve user configurations while incorporating new F5 features during upgrades. The following TMM ConfigMaps are supported for preservation:
tmm-init- TMM initialization settings (onlyuser_conf.tclfile is preserved)f5-tmm-dynamic-routing-template- BGP routing configurations and ZebOS settings
Note: Changes to tmm-init.tcl are not recommended and will not be preserved.
TODA ConfigMaps¶
TODA ConfigMaps are preserved when configurations are specified through Helm values files. The following TODA ConfigMaps are supported for preservation:
f5-toda-fluentd- Telemetry and logging configurationsf5-otel-collector-conf- OpenTelemetry collection settings
TMStats ConfigMaps¶
TMStats ConfigMaps have limited preservation capabilities—only F5 updates are preserved; user configurations are not maintained during upgrades. The following TMStats ConfigMap has limited preservation support:
f5-tmstatsd- TMM statistics and metrics configuration
ConfigMap Preservation Status Table¶
The following table shows the preservation status for all CNF ConfigMaps during upgrades:
| ConfigMap Name | User Editable | User Configs Preserved | F5 Updates Preserved |
|---|---|---|---|
tmm-init |
Y | Y | Y |
tmm-hosts |
N | - | - |
tmm-k8s-routes-configmap |
N | - | - |
f5-tmm-dynamic-routing |
Y | Y | Y |
f5-tmm-dynamic-routing-template |
Y | Y | Y |
f5ingress-config |
N | - | - |
f5ingress-services-persist |
N | - | - |
f5-toda-fluentd |
Y | Y* | Y |
f5-tmstatsd |
- | N | Y |
f5-otel-collector-conf |
Y | Y* | Y |
Legend:
Y = Yes
N = No
Y* = Yes, when using Helm values
- = Not Applicable