chore: update parameters api docs

apecloud · Mar 3, 2025 · 6ad86a6 · 6ad86a6
1 parent 16310ac
commit 6ad86a6
Show file tree

Hide file tree

Showing 35 changed files with 263 additions and 664 deletions.
diff --git a/addons/apecloud-mysql/README.md b/addons/apecloud-mysql/README.md
@@ -582,25 +582,17 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: mysql
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: my.cnf
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-        - key: innodb_buffer_pool_size
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: 512M
-        - key: max_connections
-          value: '600'
-      # Specifies the name of the configuration template.
-      name: mysql-consensusset-config
+
+   # Defines a list of key-value pairs for a single configuration file.
+   # These parameters are used to update the specified configuration settings.
+    parameters:
+     # Represents the name of the parameter that is to be updated.
+    - key: innodb_buffer_pool_size
+     # Represents the parameter values that are to be updated.
+     # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: 512M
+    - key: max_connections
+      value: '600'
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
 
@@ -979,27 +971,16 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: mysql
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-      - keys:
-          # Represents the unique identifier for the ConfigMap.
-          - key: my.cnf
-            # Defines a list of key-value pairs for a single configuration file.
-            # These parameters are used to update the specified configuration settings.
-            parameters:
-              # Represents the name of the parameter that is to be updated.
-              - key: loose_smartengine
-                # Represents the parameter values that are to be updated.
-                # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-                value: "ON"
-              - key: binlog_format
-                value: "ROW"
-              - key: default_storage_engine
-                value: "smartengine"
-        # Specifies the name of the configuration template.
-        name: mysql-consensusset-config
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+      - key: loose_smartengine
+        # Represents the parameter values that are to be updated.
+        # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+        value: "ON"
+      - key: binlog_format
+        value: "ROW"
+      - key: default_storage_engine
+        value: "smartengine"
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring
@@ -1028,27 +1009,16 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: mysql
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-      - keys:
-          # Represents the unique identifier for the ConfigMap.
-          - key: my.cnf
-            # Defines a list of key-value pairs for a single configuration file.
-            # These parameters are used to update the specified configuration settings.
-            parameters:
-              # Represents the name of the parameter that is to be updated.
-              - key: loose_smartengine
-                # Represents the parameter values that are to be updated.
-                # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-                value: "OFF"
-              - key: binlog_format
-                value: "MIXED"
-              - key: default_storage_engine
-                value: "InnoDB"
-        # Specifies the name of the configuration template.
-        name: mysql-consensusset-config
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+      - key: loose_smartengine
+        # Represents the parameter values that are to be updated.
+        # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+        value: "OFF"
+      - key: binlog_format
+        value: "MIXED"
+      - key: default_storage_engine
+        value: "InnoDB"
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring

diff --git a/addons/clickhouse/README.md b/addons/clickhouse/README.md
@@ -586,23 +586,12 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: clickhouse
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: user.xml
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-        - key: clickhouse.profiles.web.max_bytes_to_read
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: '200000000000'
-      # Specifies the name of the configuration template.
-      name: clickhouse-user-tpl
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+    - key: clickhouse.profiles.web.max_bytes_to_read
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: '200000000000'
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring
@@ -656,12 +645,9 @@ kind: OpsRequest
 spec:
   reconfigures:
   - componentName: clickhouse
-    configurations:
-    - keys:
-      - key: user.xml
-        parameters:
-        - key: clickhouse.profiles.web.max_bytes_to_read
-          value: '200000000000'
+    parameters:
+    - key: clickhouse.profiles.web.max_bytes_to_read
+      value: '200000000000'
 ```
 
 To update parameter `max_bytes_to_read`, we use the full path `clickhouse.profiles.web.max_bytes_to_read` w.r.t the `user.xml` file.

diff --git a/addons/kafka/README.md b/addons/kafka/README.md
@@ -569,23 +569,12 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: kafka-combine
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: server.properties
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-        - key: log.flush.interval.ms
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: "2000"
-      # Specifies the name of the configuration template.
-      name: kafka-configuration-tpl
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+    - key: log.flush.interval.ms
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: "2000"
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring

diff --git a/addons/mogdb/README.md b/addons/mogdb/README.md
@@ -375,25 +375,14 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: mogdb
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: postgresql.conf
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-        - key: shared_buffers
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: 512MB
-        - key: max_connections
-          value: '200'
-      # Specifies the name of the configuration template.
-      name: mogdb-configuration
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+    - key: shared_buffers
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: 512MB
+    - key: max_connections
+      value: '200'
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring

diff --git a/addons/mongodb/README.md b/addons/mongodb/README.md
@@ -576,25 +576,14 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: mongodb
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: mongodb.conf
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-        - key: systemLog.verbosity
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: "1"
-        - key: systemLog.quiet
-          value: "true"
-      # Specifies the name of the configuration template.
-      name: mongodb-config
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+    - key: systemLog.verbosity
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: "1"
+    - key: systemLog.quiet
+      value: "true"
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring

diff --git a/addons/mysql/README.md b/addons/mysql/README.md
@@ -534,23 +534,12 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: mysql
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: my.cnf
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-        - key: binlog_expire_logs_seconds
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: '691200'
-      # Specifies the name of the configuration template.
-      name: mysql-replication-config
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+    - key: binlog_expire_logs_seconds
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: '691200'
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
   type: Reconfiguring

diff --git a/addons/oceanbase-ce/README.md b/addons/oceanbase-ce/README.md
@@ -436,24 +436,13 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: oceanbase
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: oceanbase.conf
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-        # Represents the name of the parameter that is to be updated.
-        #
-        - key: system_memory
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: 2G
-      # Specifies the name of the configuration template.
-      name: oceanbase-config
+    parameters:
+    # Represents the name of the parameter that is to be updated.
+    #
+    - key: system_memory
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: 2G
   # Specifies the maximum number of seconds the OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed.
   preConditionDeadlineSeconds: 0
 ```

diff --git a/addons/postgresql/README.md b/addons/postgresql/README.md
@@ -594,24 +594,13 @@ spec:
   reconfigures:
     # Specifies the name of the Component.
   - componentName: postgresql
-   # Contains a list of ConfigurationItem objects, specifying the Component's configuration template name, upgrade policy, and parameter key-value pairs to be updated.
-    configurations:
-      # Sets the parameters to be updated. It should contain at least one item.
-      # The keys are merged and retained during patch operations.
-    - keys:
-        # Represents the unique identifier for the ConfigMap.
-      - key: postgresql.conf
-        # Defines a list of key-value pairs for a single configuration file.
-        # These parameters are used to update the specified configuration settings.
-        parameters:
-          # Represents the name of the parameter that is to be updated.
-          # `max_connections` is a dyamic parameter in PostgreSQL that can be changed or updated at runtime without requiring a restart of the database
-        - key: max_connections
-          # Represents the parameter values that are to be updated.
-          # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
-          value: '200'
-      # Specifies the name of the configuration template.
-      name: postgresql-configuration
+    parameters:
+      # Represents the name of the parameter that is to be updated.
+      # `max_connections` is a dyamic parameter in PostgreSQL that can be changed or updated at runtime without requiring a restart of the database
+    - key: max_connections
+      # Represents the parameter values that are to be updated.
+      # If set to nil, the parameter defined by the Key field will be removed from the configuration file.
+      value: '200'
 ```
 
 ```bash