Merge pull request #454 from percona/9652

PS-9652 [DOCS] - audit_log_filter plugin to component migration 8.4

Author: patrickbirch

docs/upgrade-components.md

@@ -2,41 +2,71 @@
 
 The following plugins have changed:
 
+<style>
+table {
+  table-layout: fixed; /* Ensures the table width fits within the page */
+  width: 100%; /* Sets the table to take up the full page width */
+  border-collapse: collapse;
+}
+
+th, td {
+  border: 1px solid #ddd; /* Optional: Add a border for better visibility */
+  padding: 8px; /* Optional: Add padding for readability */
+}
+
+th:first-child, td:first-child {
+  width: 1%; /* Makes the first column fit the content */
+  white-space: nowrap; /* Prevents wrapping in the first column */
+}
+
+th:nth-child(3), td:nth-child(3) {
+  width: 1%; /* Makes the third column fit the content */
+  white-space: nowrap; /* Prevents wrapping in the third column */
+}
+</style>
+
+
 | Plugin | 8.0 information | {{vers}} changes | Notes |
 |---|---|---|---|
 | `keyring_vault` | Only available as a plugin | `component_keyring_vault` | A manual upgrade path is required. For example, the plugin configuration file, specified by the `keyring_vault_config` system variable, must be transformed to a JSON format for the `component_keyring_vault.cnf`. |
 | `audit_log` | Only available as a plugin | removed | Recommended that you use the `component_audit_log_filter`. |
-| `audit_log_filter` | Only available as a plugin | `component_audit_log_filter` | Migrate the plugin to the component in 8.0 before the upgrade to {{vers}}. |
-| `data_masking` | Available as a plugin and component | `component_masking_functions` | Migrate the plugin to the component in 8.0 before the upgrade to {{vers}} |
+| `audit_log_filter` | Only available as a plugin | `component_audit_log_filter` | Transition the plugin to the component after the upgrade to {{vers}}. |
+| `data_masking` | Available as a plugin and component | `component_masking_functions` | Transition the plugin to the component in 8.0 before the upgrade to {{vers}} |
 | `binlog_utils_udf` user defined functions | Only available as plugin. Users must install the plugin and then run `CREATE FUNCTION ... SONAME...` | `component_binlog_utils_udf` | Run `INSTALL COMPONENT` and all functions are registered automatically. |
 | `percona-udf` user defined functions | Must create individual functions with `CREATE FUNCTION ... SONAME ...`. | `component_percona_udf` | Run `INSTALL COMPONENT` and all functions are registered automatically. Can still use `CREATE FUNCTION ... SONAME ...` if needed. |
 
 We recommend if you use a plugin and the feature also available a component, switch to the component in 8.0 series before upgrading to {{vers}}.
 
-## Transition from a plugin to a component
+## Transition a plugin to a component
+
+The operation to transition from a plugin to a component can be complicated. Always test the migration in a staging environment before applying the changes to the production servers. To ensure there is minimal interruption, the key preparation steps are the following:
+
+* Plan for downtime 
+
+* Create a comprehensive testing strategy
 
-The operation to transition from a plugin to a component can be complicated. You should plan for downtime while you plan and test each step in the procedure.
+* Verify that the existing functionality transfers correctly
 
 Before you start, review the differences between the plugin and the component. A plugin configuration has plugin-specific system variables and uses the `--early-plugin-load` option. A component has a configuration file and loads using a manifest.
 
 1. Setup the component's configuration file.
 
-2. Use the manifest to load the component.
+2. Load the component using the manifest.
 
-3. Confirm that the component works. Run queries or other operations and test the component in your environment.
+3. Confirm that the component works. Run queries or other operations and test the component thoroughtly in your test environment.
 
-4. After confirmation, remove the plugin.
+4. After confirmation, remove the original plugin.
 
 Some plugins may require more configuration and setup during the transition to a component. For those plugins, you may have the following scenario:
 
 1. Test the plugin in 8.0.
 
 2. Stop the service
 
-3. Upgrade the packages to {{vers}}
+3. Upgrade to {{vers}}
 
-4. Review and edit configurations, as needed
+4. Review and adjust the configurations, as needed
 
-5. Start {{vers}}
+5. Start the new {{vers}}
 
-6. Test the component in {{vers}}
+6. Confirm the component in {{vers}}

mkdocs-base.yml

@@ -221,15 +221,15 @@ nav:
     - Install Percona Server for MySQL Pro:
       - install-pro.md
       - pro-files.md
-    - Upgrade:
-      - upgrade.md
-      - upgrade-strategies.md
-      - upgrade-components.md
-      - upgrade-percona-repos.md
-      - upgrade-standalone-packages.md
-      - upgrade-pro.md
-      - downgrade.md
-      - downgrade-from-pro.md
+  - Upgrade:
+    - upgrade.md
+    - upgrade-strategies.md
+    - upgrade-components.md
+    - upgrade-percona-repos.md
+    - upgrade-standalone-packages.md
+    - upgrade-pro.md
+    - downgrade.md
+    - downgrade-from-pro.md
   - Post-Installation:
     - binlogging-replication-improvements.md
     - post-installation.md