From cb7be9530f088c1553759b0dc5194c58c3f0ae4f Mon Sep 17 00:00:00 2001 From: cheyang Date: Mon, 23 Dec 2024 10:54:39 +0800 Subject: [PATCH] Update API docs, To #58781286 (#4448) Signed-off-by: cheyang --- docs/en/dev/api_doc.md | 256 +++++++++++++++++++++++++++++++++++++++-- docs/zh/dev/api_doc.md | 254 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 497 insertions(+), 13 deletions(-) diff --git a/docs/en/dev/api_doc.md b/docs/en/dev/api_doc.md index 995e5bf0e78..9a5d9219ae0 100644 --- a/docs/en/dev/api_doc.md +++ b/docs/en/dev/api_doc.md @@ -2008,6 +2008,20 @@ CleanCachePolicy

Volumes is the list of Kubernetes volumes that can be mounted by the jindo runtime components and/or fuses.

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets that will be used to pull images

+ + @@ -2448,6 +2462,20 @@ RuntimeManagement

RuntimeManagement defines policies when managing the runtime

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets that will be used to pull images

+ + @@ -2732,6 +2760,20 @@ string +dependOn
+ + +ObjectRef + + + + +(Optional) +

Specifies the dependent preceding operation in a workflow. If not set, use the operation referred to by RunAfter.

+ + + + policy
@@ -3081,7 +3123,7 @@ map[string]string (Optional)

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

+this option only effect when global is enabled

@@ -3517,6 +3559,48 @@ of retries. This gives you the option to continue processing retries.

+

ClientMetrics +

+

+(Appears on: +JindoFuseSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+enabled
+ +bool + +		 +

Enabled decides whether to expose client metrics.

+
+scrapeTarget
+ +string + +		 +

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.

+

Condition

@@ -6373,6 +6457,19 @@ bool

VolumeMounts specifies the volumes listed in “.spec.volumes” to mount into the jindo runtime component’s filesystem.

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +

ImagePullSecrets that will be used to pull images

+ +

JindoFuseSpec @@ -6427,6 +6524,19 @@ string +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +

ImagePullSecrets that will be used to pull images

+ + + + properties
map[string]string @@ -6571,6 +6681,20 @@ map[string]string (Optional) + + +metrics
+ + +ClientMetrics + + + + +(Optional) +

Define whether fuse metrics will be enabled.

+ +

JindoRuntimeSpec @@ -6806,6 +6930,20 @@ CleanCachePolicy

Volumes is the list of Kubernetes volumes that can be mounted by the jindo runtime components and/or fuses.

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets that will be used to pull images

+ +

JobProcessor @@ -7796,14 +7934,12 @@ not enabled by default.

-

OperationRef +

ObjectRef

(Appears on: -DataBackupSpec, -DataLoadSpec, -DataMigrateSpec, -DataProcessSpec) +AffinityStrategy, +OperationRef)

@@ -7861,6 +7997,42 @@ string

Namespace specifies the namespace of the referent operation.

+ + +

OperationRef +

+

+(Appears on: +DataBackupSpec, +DataLoadSpec, +DataMigrateSpec, +DataProcessSpec) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+ObjectRef
+ + +ObjectRef + + +		 +

+(Members of ObjectRef are embedded into this type.) +

+
affinityStrategy
@@ -9162,6 +9334,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
replicas
int32 @@ -9349,6 +9535,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
ports
@@ -9563,6 +9763,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
worker
@@ -9661,6 +9875,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
worker
@@ -9855,6 +10083,20 @@ RuntimeManagement

RuntimeManagement defines policies when managing the runtime
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+

TieredStore @@ -10627,5 +10869,5 @@ bool

Generated with gen-crd-api-reference-docs -on git commit e8adb7d8. +on git commit fc07663.

diff --git a/docs/zh/dev/api_doc.md b/docs/zh/dev/api_doc.md index 5cf48b48c28..9a5d9219ae0 100644 --- a/docs/zh/dev/api_doc.md +++ b/docs/zh/dev/api_doc.md @@ -2008,6 +2008,20 @@ CleanCachePolicy

Volumes is the list of Kubernetes volumes that can be mounted by the jindo runtime components and/or fuses.

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets that will be used to pull images

+ + @@ -2448,6 +2462,20 @@ RuntimeManagement

RuntimeManagement defines policies when managing the runtime

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets that will be used to pull images

+ + @@ -2732,6 +2760,20 @@ string +dependOn
+ + +ObjectRef + + + + +(Optional) +

Specifies the dependent preceding operation in a workflow. If not set, use the operation referred to by RunAfter.

+ + + + policy
@@ -3517,6 +3559,48 @@ of retries. This gives you the option to continue processing retries.

+

ClientMetrics +

+

+(Appears on: +JindoFuseSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+enabled
+ +bool + +		 +

Enabled decides whether to expose client metrics.

+
+scrapeTarget
+ +string + +		 +

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.

+

Condition

@@ -6373,6 +6457,19 @@ bool

VolumeMounts specifies the volumes listed in “.spec.volumes” to mount into the jindo runtime component’s filesystem.

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +

ImagePullSecrets that will be used to pull images

+ +

JindoFuseSpec @@ -6427,6 +6524,19 @@ string +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +

ImagePullSecrets that will be used to pull images

+ + + + properties
map[string]string @@ -6571,6 +6681,20 @@ map[string]string (Optional) + + +metrics
+ + +ClientMetrics + + + + +(Optional) +

Define whether fuse metrics will be enabled.

+ +

JindoRuntimeSpec @@ -6806,6 +6930,20 @@ CleanCachePolicy

Volumes is the list of Kubernetes volumes that can be mounted by the jindo runtime components and/or fuses.

+ + +imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets that will be used to pull images

+ +

JobProcessor @@ -7796,14 +7934,12 @@ not enabled by default.

-

OperationRef +

ObjectRef

(Appears on: -DataBackupSpec, -DataLoadSpec, -DataMigrateSpec, -DataProcessSpec) +AffinityStrategy, +OperationRef)

@@ -7861,6 +7997,42 @@ string

Namespace specifies the namespace of the referent operation.

+ + +

OperationRef +

+

+(Appears on: +DataBackupSpec, +DataLoadSpec, +DataMigrateSpec, +DataProcessSpec) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+ObjectRef
+ + +ObjectRef + + +		 +

+(Members of ObjectRef are embedded into this type.) +

+
affinityStrategy
@@ -9162,6 +9334,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
replicas
int32 @@ -9349,6 +9535,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
ports
@@ -9563,6 +9763,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
worker
@@ -9661,6 +9875,20 @@ string
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+
worker
@@ -9855,6 +10083,20 @@ RuntimeManagement

RuntimeManagement defines policies when managing the runtime
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +(Optional) +

ImagePullSecrets that will be used to pull images

+

TieredStore @@ -10627,5 +10869,5 @@ bool

Generated with gen-crd-api-reference-docs -on git commit e8adb7d8. +on git commit fc07663.