Skip to content

Commit

Permalink
Update API docs, To #58781286 (#4448)
Browse files Browse the repository at this point in the history 
Signed-off-by: cheyang <cheyang@163.com>
  • Loading branch information
@cheyang
cheyang authored Dec 23, 2024
1 parent fc07663 commit cb7be95
Show file tree
Hide file tree
Showing 2 changed files with 497 additions and 13 deletions.
256 changes: 249 additions & 7 deletions docs/en/dev/api_doc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2008,6 +2008,20 @@ CleanCachePolicy
<p>Volumes is the list of Kubernetes volumes that can be mounted by the jindo runtime components and/or fuses.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
</table>
</td>
</tr>
Expand Down Expand Up @@ -2448,6 +2462,20 @@ RuntimeManagement
<p>RuntimeManagement defines policies when managing the runtime</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
</table>
</td>
</tr>
Expand Down Expand Up @@ -2732,6 +2760,20 @@ string
<tbody>
<tr>
<td>
<code>dependOn</code></br>
<em>
<a href="#data.fluid.io/v1alpha1.ObjectRef">
ObjectRef
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Specifies the dependent preceding operation in a workflow. If not set, use the operation referred to by RunAfter.</p>
</td>
</tr>
<tr>
<td>
<code>policy</code></br>
<em>
<a href="#data.fluid.io/v1alpha1.AffinityPolicy">
Expand Down Expand Up @@ -3081,7 +3123,7 @@ map[string]string
<td>
<em>(Optional)</em>
<p>NodeSelector is a selector which must be true for the fuse client to fit on a node,
this option only affects when global is enabled</p>
this option only effect when global is enabled</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -3517,6 +3559,48 @@ of retries. This gives you the option to continue processing retries.</p>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.ClientMetrics">ClientMetrics
</h3>
<p>
(<em>Appears on:</em>
<a href="#data.fluid.io/v1alpha1.JindoFuseSpec">JindoFuseSpec</a>)
</p>
<p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>enabled</code></br>
<em>
bool
</em>
</td>
<td>
<p>Enabled decides whether to expose client metrics.</p>
</td>
</tr>
<tr>
<td>
<code>scrapeTarget</code></br>
<em>
string
</em>
</td>
<td>
<p>ScrapeTarget decides which fuse component will be scraped by Prometheus.
It is a list separated by comma where supported items are [MountPod, Sidecar, All (indicates MountPod and Sidecar), None].
Defaults to None when it is not explicitly set.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.Condition">Condition
</h3>
<p>
Expand Down Expand Up @@ -6373,6 +6457,19 @@ bool
<p>VolumeMounts specifies the volumes listed in &ldquo;.spec.volumes&rdquo; to mount into the jindo runtime component&rsquo;s filesystem.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.JindoFuseSpec">JindoFuseSpec
Expand Down Expand Up @@ -6427,6 +6524,19 @@ string
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
<tr>
<td>
<code>properties</code></br>
<em>
map[string]string
Expand Down Expand Up @@ -6571,6 +6681,20 @@ map[string]string
<em>(Optional)</em>
</td>
</tr>
<tr>
<td>
<code>metrics</code></br>
<em>
<a href="#data.fluid.io/v1alpha1.ClientMetrics">
ClientMetrics
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Define whether fuse metrics will be enabled.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.JindoRuntimeSpec">JindoRuntimeSpec
Expand Down Expand Up @@ -6806,6 +6930,20 @@ CleanCachePolicy
<p>Volumes is the list of Kubernetes volumes that can be mounted by the jindo runtime components and/or fuses.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.JobProcessor">JobProcessor
Expand Down Expand Up @@ -7796,14 +7934,12 @@ not enabled by default.</p>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.OperationRef">OperationRef
<h3 id="data.fluid.io/v1alpha1.ObjectRef">ObjectRef
</h3>
<p>
(<em>Appears on:</em>
<a href="#data.fluid.io/v1alpha1.DataBackupSpec">DataBackupSpec</a>,
<a href="#data.fluid.io/v1alpha1.DataLoadSpec">DataLoadSpec</a>,
<a href="#data.fluid.io/v1alpha1.DataMigrateSpec">DataMigrateSpec</a>,
<a href="#data.fluid.io/v1alpha1.DataProcessSpec">DataProcessSpec</a>)
<a href="#data.fluid.io/v1alpha1.AffinityStrategy">AffinityStrategy</a>,
<a href="#data.fluid.io/v1alpha1.OperationRef">OperationRef</a>)
</p>
<p>
</p>
Expand Down Expand Up @@ -7861,6 +7997,42 @@ string
<p>Namespace specifies the namespace of the referent operation.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.OperationRef">OperationRef
</h3>
<p>
(<em>Appears on:</em>
<a href="#data.fluid.io/v1alpha1.DataBackupSpec">DataBackupSpec</a>,
<a href="#data.fluid.io/v1alpha1.DataLoadSpec">DataLoadSpec</a>,
<a href="#data.fluid.io/v1alpha1.DataMigrateSpec">DataMigrateSpec</a>,
<a href="#data.fluid.io/v1alpha1.DataProcessSpec">DataProcessSpec</a>)
</p>
<p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>ObjectRef</code></br>
<em>
<a href="#data.fluid.io/v1alpha1.ObjectRef">
ObjectRef
</a>
</em>
</td>
<td>
<p>
(Members of <code>ObjectRef</code> are embedded into this type.)
</p>
</td>
</tr>
<tr>
<td>
<code>affinityStrategy</code></br>
Expand Down Expand Up @@ -9162,6 +9334,20 @@ string
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
<tr>
<td>
<code>replicas</code></br>
<em>
int32
Expand Down Expand Up @@ -9349,6 +9535,20 @@ string
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
<tr>
<td>
<code>ports</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#containerport-v1-core">
Expand Down Expand Up @@ -9563,6 +9763,20 @@ string
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
<tr>
<td>
<code>worker</code></br>
<em>
<a href="#data.fluid.io/v1alpha1.ThinCompTemplateSpec">
Expand Down Expand Up @@ -9661,6 +9875,20 @@ string
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
<tr>
<td>
<code>worker</code></br>
<em>
<a href="#data.fluid.io/v1alpha1.ThinCompTemplateSpec">
Expand Down Expand Up @@ -9855,6 +10083,20 @@ RuntimeManagement
<p>RuntimeManagement defines policies when managing the runtime</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>ImagePullSecrets that will be used to pull images</p>
</td>
</tr>
</tbody>
</table>
<h3 id="data.fluid.io/v1alpha1.TieredStore">TieredStore
Expand Down Expand Up @@ -10627,5 +10869,5 @@ bool
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>e8adb7d8</code>.
on git commit <code>fc07663</code>.
</em></p>
Loading

0 comments on commit cb7be95

Please sign in to comment.