update

helm-chart/README.md

@@ -0,0 +1,77 @@
+## judgeflow chart 的要求
+
+### values.yaml 文件必须包含如下字段，并且模板中必须引用 values.yaml 中的如下字段
+
+```
+podLabels
+env
+volumeMounts
+volumes
+affinity
+```
+
+### values.yaml 文件必须在 volumeMounts 中声明如下卷
+
+```
+workspace
+submit
+datafile
+```
+
+## 被测服务（sut） chart 的要求
+
+### values.yaml 文件必须包含如下字段，并且资源模板中必须引用 values.yaml 中的如下字段
+
+```
+podLabels
+affinity
+```
+
+针对 podLabels 字段，values.yaml 中配置格式如下：
+
+```
+podLabels: {}
+```
+
+下面给出示例
+
+podLabels
+
+values.yaml
+
+templates/deployment.yaml
+
+```
+metadata:
+  labels:
+    {{- with .Values.podLabels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+```
+
+affinity
+
+values.yaml
+
+```
+affinity: {}
+```
+
+templates/deployment.yaml
+
+```
+spec:
+  template:
+    spec:
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+```
+
+### 如果需要在 sut 中使用共享存储，则 sut chart 的 values.yaml 也必须包含如下字段，且模板中必须引用 values.yaml 中的如下字段
+
+```
+volumeMounts
+volumes
+```