AAP-39131 - Created the assembly first. (#5950)

downstream/assemblies/platform/assembly-aap-backup-database-compression-for-operator-based-deployments.adoc

@@ -0,0 +1,22 @@
+ifdef::context[:parent-context: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+[id="aap-backup-database-compression-for-operator-based-deployments"]
+
+= Backup database compression for operator-based deployments
+
+:context: backup-database-compression-for-operator-based-deployments
+
+[role="_abstract"]
+
+{PlatformNameShort} {PlatformVers} supports database compression for operator-based backup operations. You can enable or disable compression globally or per component to optimize backup size and performance.
+
+When you enable database compression, the operator compresses the PostgreSQL database dump for each component. This reduces the overall backup size but increases CPU usage during the backup process.
+
+include::platform/ref-backup-compression-configuration-parameters.adoc[leveloffset=+1]
+
+include::platform/proc-configure-backup-compression.adoc[leveloffset=+1]
+
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]

downstream/modules/platform/proc-configure-backup-compression.adoc

@@ -0,0 +1,61 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="proc-configure-backup-compression"]
+
+= Configure backup compression 
+
+[role="_abstract"]
+
+Configure database compression for your {PlatformNameShort} backup by setting compression parameters in the `AnsibleAutomationPlatformBackup` custom resource.
+
+.Prerequisites
+* You have installed {PlatformNameShort} {PlatformVers} by using the operator.
+* You have administrator access to the {OCP} cluster.
+
+.Procedure
+
+. Create or edit an `AnsibleAutomationPlatformBackup` custom resource file. The following example enables compression globally but disables it for automation controller:
++
+[source,bash]
+----
+apiVersion: aap.ansible.com/v1alpha1
+kind: AnsibleAutomationPlatformBackup
+metadata:
+  name: aap-backup
+  namespace: aap
+spec:
+  deployment_name: aap
+
+  # Global — applies to gateway and all child components by default
+  use_db_compression: true
+
+  # Per-component override (optional)
+  controller:
+    use_db_compression: false   # disable compression for controller only
+----
++
+. Apply the custom resource to your cluster:
++
+[source,bash]
+----
+$ oc apply -f <backup_cr_file>.yml
+----
++
+. Monitor the backup progress:
++
+[source,bash]
+----
+$ oc get ansibleautomationplatformbackup -n aap -w
+----
+
+.Verification
+
+* Verify that the backup completed successfully:
++
+[source,bash]
+----
+$ oc get ansibleautomationplatformbackup <backup_name> -n aap -o jsonpath='{.status.conditions}'
+----
++
+The output shows a `Successful` condition when the backup completes.
+

downstream/modules/platform/ref-backup-compression-configuration-parameters.adoc

@@ -0,0 +1,36 @@
+:_mod-docs-content-type: REFERENCE
+
+[id="ref-backup-compression-configuration-parameters"]
+
+= Backup compression configuration parameters
+
+[role="_abstract"]
+
+Use these compression parameters to configure the `AnsibleAutomationPlatformBackup` custom resource:
+
+[cols="a,a,a"]
+|===
+| Parameter | Description | Default
+
+| `spec.use_db_compression`
+| Enables or disables database dump compression for all components globally.
+| `True`
+
+| `spec.gateway.use_db_compression`
+| Overrides the global compression setting for the {Gateway}.
+| Value of `spec.use_db_compression`
+
+| `spec.controller.use_db_compression`
+| Overrides the global compression setting for {ControllerName}.
+| Value of `spec.use_db_compression`
+
+| `spec.hub.use_db_compression`
+| Overrides the global compression setting for {HubName}.
+| Value of `spec.use_db_compression`
+
+| `spec.eda.use_db_compression`
+| Overrides the global compression setting for {EDAName}.
+| Value of `spec.use_db_compression`
+|===
+
+When you set a per-component parameter, it overrides the global `spec.use_db_compression` value for that component only.