ChenYi015 commented on code in PR #2506:
URL: https://github.com/apache/celeborn/pull/2506#discussion_r1598227238


##########
charts/celeborn/values.yaml:
##########
@@ -19,41 +19,52 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
-# we provide a default celeborn image, you can also replace to your image
-# TODO rebuild celeborn official image
+# -- String to override the default generated name
+nameOverride: ""
+
+# -- String to override the default generated fullname
+fullnameOverride: ""
+
+# Specifies the Celeborn image to use
 image:
+  # -- Image repository
   repository: aliyunemr/remote-shuffle-service
-  pullPolicy: Always
+  # -- Image tag
   tag: 0.1.1-6badd20
+  # -- Image pull policy
+  pullPolicy: Always
 
+# -- Image pull secrets for private image registry
 imagePullSecrets: []
 
-# master replicas should not less than 3
+# -- Specifies the number of Celeborn master replicas to deploy, master 
replicas should not less than 3
 masterReplicas: 3
-# worker replicas set on demand, should less than node number
+# -- Specifies the number of Celeborn worker replicas to deploy, should less 
than node number
 workerReplicas: 5
 
-hostNetwork: false
-dnsPolicy: ClusterFirst
+service:
+  # -- Specifies service type
+  type: ClusterIP
+  # -- Specifies service port
+  port: 9097
 
-securityContext:
-  runAsUser: 10006
-  runAsGroup: 10006
-  fsGroup: 10006
+cluster:
+  # -- Specifies Kubernetes cluster name
+  name: cluster
 
-# Current Celeborn support followings volume type:
-# - emptyDir
-# - hostPath
-# Note:
-# hostPath only works in hostPath type using to set `volumes hostPath path`
-# Celeborn Master will pick first volumes for store raft log
-# diskType only works in Celeborn Worker with hostPath type to manifest local 
disk type
+# -- Specifies Celeborn volumes.
+# Currently supported volume types are `emptyDir` and `hostPath`. <br>
+# Note that `hostPath` only works in hostPath type using to set `volumes 
hostPath path`.
+# Celeborn Master will pick first volumes for store raft log. <br>
+# `diskType` only works in Celeborn Worker with hostPath type to manifest 
local disk type.
 volumes:
+  # @ignore

Review Comment:
   > what does `@ignore` use for? and ignore what?
   
   @pan3793 It's used by helm-docs to generate values section in helm chart 
README.md. Without `@ignore` annotation, the values of volumes will be rendered 
in README file, which is too long and will make it hard to read.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to