Skip to content

Commit

Permalink
chore: refine configConstraint api doc (apecloud#7389)
Browse files Browse the repository at this point in the history
  • Loading branch information
Y-Rookie authored May 20, 2024
1 parent 5b1a49b commit ffa9245
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions apis/apps/v1alpha1/configconstraint_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type ConfigConstraintSpec struct {
// Dynamic reloading is triggered only if both of the following conditions are met:
//
// 1. The modified parameters are listed in the `dynamicParameters` field.
// If `dynamicParameterSelectedPolicy` is set to "all", modifications to `staticParameters`
// If `reloadStaticParamsBeforeRestart` is set to true, modifications to `staticParameters`
// can also trigger a reload.
// 2. `reloadOptions` is set.
//
Expand Down Expand Up @@ -67,7 +67,7 @@ type ConfigConstraintSpec struct {
// will trigger a dynamic reload.
// - true: Modifications to both dynamic parameters listed in `dynamicParameters` and static parameters
// listed in `staticParameters` will trigger a dynamic reload.
// The "all" option is for certain engines that require static parameters to be set
// The "true" option is for certain engines that require static parameters to be set
// via SQL statements before they can take effect on restart.
//
// +optional
Expand Down
10 changes: 5 additions & 5 deletions config/crd/bases/apps.kubeblocks.io_configconstraints.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,10 @@ spec:
engine. When set, the controller executes the method defined here
to execute hot parameter updates. \n Dynamic reloading is triggered
only if both of the following conditions are met: \n 1. The modified
parameters are listed in the `dynamicParameters` field. If `dynamicParameterSelectedPolicy`
is set to \"all\", modifications to `staticParameters` can also
trigger a reload. 2. `reloadOptions` is set. \n If `reloadOptions`
is not set or the modified parameters are not listed in `dynamicParameters`,
parameters are listed in the `dynamicParameters` field. If `reloadStaticParamsBeforeRestart`
is set to true, modifications to `staticParameters` can also trigger
a reload. 2. `reloadOptions` is set. \n If `reloadOptions` is not
set or the modified parameters are not listed in `dynamicParameters`,
dynamic reloading will not be triggered. \n Example: ```yaml reloadOptions:
tplScriptTrigger: namespace: kb-system scriptConfigMapRef: mysql-reload-script
sync: true ```"
Expand Down Expand Up @@ -515,7 +515,7 @@ spec:
the dynamic parameters listed in `dynamicParameters` will trigger
a dynamic reload. - true: Modifications to both dynamic parameters
listed in `dynamicParameters` and static parameters listed in `staticParameters`
will trigger a dynamic reload. The \"all\" option is for certain
will trigger a dynamic reload. The \"true\" option is for certain
engines that require static parameters to be set via SQL statements
before they can take effect on restart."
type: boolean
Expand Down
10 changes: 5 additions & 5 deletions deploy/helm/crds/apps.kubeblocks.io_configconstraints.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,10 @@ spec:
engine. When set, the controller executes the method defined here
to execute hot parameter updates. \n Dynamic reloading is triggered
only if both of the following conditions are met: \n 1. The modified
parameters are listed in the `dynamicParameters` field. If `dynamicParameterSelectedPolicy`
is set to \"all\", modifications to `staticParameters` can also
trigger a reload. 2. `reloadOptions` is set. \n If `reloadOptions`
is not set or the modified parameters are not listed in `dynamicParameters`,
parameters are listed in the `dynamicParameters` field. If `reloadStaticParamsBeforeRestart`
is set to true, modifications to `staticParameters` can also trigger
a reload. 2. `reloadOptions` is set. \n If `reloadOptions` is not
set or the modified parameters are not listed in `dynamicParameters`,
dynamic reloading will not be triggered. \n Example: ```yaml reloadOptions:
tplScriptTrigger: namespace: kb-system scriptConfigMapRef: mysql-reload-script
sync: true ```"
Expand Down Expand Up @@ -515,7 +515,7 @@ spec:
the dynamic parameters listed in `dynamicParameters` will trigger
a dynamic reload. - true: Modifications to both dynamic parameters
listed in `dynamicParameters` and static parameters listed in `staticParameters`
will trigger a dynamic reload. The \"all\" option is for certain
will trigger a dynamic reload. The \"true\" option is for certain
engines that require static parameters to be set via SQL statements
before they can take effect on restart."
type: boolean
Expand Down
8 changes: 4 additions & 4 deletions docs/developer_docs/api-reference/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -1946,7 +1946,7 @@ When set, the controller executes the method defined here to execute hot paramet
<p>Dynamic reloading is triggered only if both of the following conditions are met:</p>
<ol>
<li>The modified parameters are listed in the <code>dynamicParameters</code> field.
If <code>dynamicParameterSelectedPolicy</code> is set to &ldquo;all&rdquo;, modifications to <code>staticParameters</code>
If <code>reloadStaticParamsBeforeRestart</code> is set to true, modifications to <code>staticParameters</code>
can also trigger a reload.</li>
<li><code>reloadOptions</code> is set.</li>
</ol>
Expand Down Expand Up @@ -1995,7 +1995,7 @@ to all parameters (including static parameters).</p>
will trigger a dynamic reload.</li>
<li>true: Modifications to both dynamic parameters listed in <code>dynamicParameters</code> and static parameters
listed in <code>staticParameters</code> will trigger a dynamic reload.
The &ldquo;all&rdquo; option is for certain engines that require static parameters to be set
The &ldquo;true&rdquo; option is for certain engines that require static parameters to be set
via SQL statements before they can take effect on restart.</li>
</ul>
</td>
Expand Down Expand Up @@ -9565,7 +9565,7 @@ When set, the controller executes the method defined here to execute hot paramet
<p>Dynamic reloading is triggered only if both of the following conditions are met:</p>
<ol>
<li>The modified parameters are listed in the <code>dynamicParameters</code> field.
If <code>dynamicParameterSelectedPolicy</code> is set to &ldquo;all&rdquo;, modifications to <code>staticParameters</code>
If <code>reloadStaticParamsBeforeRestart</code> is set to true, modifications to <code>staticParameters</code>
can also trigger a reload.</li>
<li><code>reloadOptions</code> is set.</li>
</ol>
Expand Down Expand Up @@ -9614,7 +9614,7 @@ to all parameters (including static parameters).</p>
will trigger a dynamic reload.</li>
<li>true: Modifications to both dynamic parameters listed in <code>dynamicParameters</code> and static parameters
listed in <code>staticParameters</code> will trigger a dynamic reload.
The &ldquo;all&rdquo; option is for certain engines that require static parameters to be set
The &ldquo;true&rdquo; option is for certain engines that require static parameters to be set
via SQL statements before they can take effect on restart.</li>
</ul>
</td>
Expand Down

0 comments on commit ffa9245

Please sign in to comment.