chore: update api doc

apecloud · Dec 4, 2024 · 03253e6 · 03253e6
1 parent a637605
commit 03253e6
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 104 deletions.
diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -863,32 +863,6 @@ rules:
   - get
   - patch
   - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - componentparameters
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - componentparameters/finalizers
-  verbs:
-  - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - componentparameters/status
-  verbs:
-  - get
-  - patch
-  - update
 - apiGroups:
   - parameters.kubeblocks.io
   resources:
@@ -915,32 +889,6 @@ rules:
   - get
   - patch
   - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - parameters
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - parameters/finalizers
-  verbs:
-  - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - parameters/status
-  verbs:
-  - get
-  - patch
-  - update
 - apiGroups:
   - parameters.kubeblocks.io
   resources:

diff --git a/deploy/helm/config/rbac/role.yaml b/deploy/helm/config/rbac/role.yaml
@@ -863,32 +863,6 @@ rules:
   - get
   - patch
   - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - componentparameters
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - componentparameters/finalizers
-  verbs:
-  - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - componentparameters/status
-  verbs:
-  - get
-  - patch
-  - update
 - apiGroups:
   - parameters.kubeblocks.io
   resources:
@@ -915,32 +889,6 @@ rules:
   - get
   - patch
   - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - parameters
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - parameters/finalizers
-  verbs:
-  - update
-- apiGroups:
-  - parameters.kubeblocks.io
-  resources:
-  - parameters/status
-  verbs:
-  - get
-  - patch
-  - update
 - apiGroups:
   - parameters.kubeblocks.io
   resources:

diff --git a/docs/developer_docs/api-reference/cluster.md b/docs/developer_docs/api-reference/cluster.md
@@ -853,6 +853,20 @@ If set, all the computing resources will be released.</p>
 <p>Specifies the sidecars to be injected into the Component.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>initParameters</code><br/>
+<em>
+<a href="#apps.kubeblocks.io/v1.ComponentParameter">
+[]ComponentParameter
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Specifies the initialization parameters.</p>
+</td>
+</tr>
 </table>
 </td>
 </tr>
@@ -3122,6 +3136,20 @@ bool
 If set, all the computing resources will be released.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>initParameters</code><br/>
+<em>
+<a href="#apps.kubeblocks.io/v1.ComponentParameter">
+[]ComponentParameter
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Specifies the initialization parameters.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="apps.kubeblocks.io/v1.ClusterComponentStatus">ClusterComponentStatus
@@ -5795,6 +5823,47 @@ and other administrative tasks.</p>
 </tr>
 </tbody>
 </table>
+<h3 id="apps.kubeblocks.io/v1.ComponentParameter">ComponentParameter
+</h3>
+<p>
+(<em>Appears on:</em><a href="#apps.kubeblocks.io/v1.ClusterComponentSpec">ClusterComponentSpec</a>, <a href="#apps.kubeblocks.io/v1.ComponentSpec">ComponentSpec</a>)
+</p>
+<div>
+</div>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>name</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<p>Specifies the name of the parameter that is to be updated.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>value</code><br/>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Specifies 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.</p>
+</td>
+</tr>
+</tbody>
+</table>
 <h3 id="apps.kubeblocks.io/v1.ComponentPhase">ComponentPhase
 (<code>string</code> alias)</h3>
 <p>
@@ -6336,6 +6405,20 @@ If set, all the computing resources will be released.</p>
 <p>Specifies the sidecars to be injected into the Component.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>initParameters</code><br/>
+<em>
+<a href="#apps.kubeblocks.io/v1.ComponentParameter">
+[]ComponentParameter
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Specifies the initialization parameters.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="apps.kubeblocks.io/v1.ComponentStatus">ComponentStatus