feat(portal): 在适配器为 K8S 的时候，提交作业页面增加输入框：镜像地址

.changeset/dry-clouds-complain.md

@@ -0,0 +1,5 @@
+---
+"@scow/grpc-api": minor
+---
+
+submitJob 增加参数 extraOptions，类型为map<string, string>，暂时只支持k8sImageUrl属性

.changeset/tricky-schools-taste.md

@@ -0,0 +1,7 @@
+---
+"@scow/portal-server": minor
+"@scow/portal-web": minor
+"@scow/docs": minor
+---
+
+在适配器为 K8S 的时候，提交作业页面增加输入框：镜像地址

apps/portal-server/src/clusterops/api/job.ts

@@ -29,6 +29,9 @@ export interface JobTemplate {
   errorOutput?: string;
   memory?: string;
   comment?: string | undefined;
+  extraOptions: {
+    [key: string]: string;
+  }
 }
 
 export interface ListJobTemplatesRequest {

apps/portal-server/src/clusterops/job.ts

@@ -32,6 +32,9 @@ export interface JobMetadata {
   submitTime: string;
   workingDirectory: string;
   memory?: string;
+  extraOptions: {
+    [key: string]: string;
+  }
 }
 
 export const jobOps = (cluster: string): JobOps => {

apps/portal-server/src/services/job.ts

@@ -156,10 +156,9 @@ export const jobServiceServer = plugin((server) => {
     },
 
     submitJob: async ({ request, logger }) => {
-      const { cluster, command, jobName, coreCount, gpuCount, maxTime, saveAsTemplate, userId,
+      const { cluster, command, jobName, coreCount, gpuCount, maxTime, saveAsTemplate, userId, extraOptions,
         nodeCount, partition, qos, account, comment, workingDirectory, output, errorOutput, memory } = request;
 
-
       const client = getAdapterClient(cluster);
       if (!client) { throw clusterNotFound(cluster); }
 
@@ -174,7 +173,8 @@ export const jobServiceServer = plugin((server) => {
       const reply = await asyncClientCall(client.job, "submitJob", {
         userId, jobName, account, partition: partition!, qos, nodeCount, gpuCount: gpuCount || 0,
         memoryMb: Number(memory?.split("M")[0]), coreCount, timeLimitMinutes: maxTime,
-        script: command, workingDirectory, stdout: output, stderr: errorOutput, extraOptions: [],
+        script: command, workingDirectory, stdout: output, stderr: errorOutput,
+        extraOptions: Object.values(extraOptions).length ? Object.values(extraOptions) : [],
       }).catch((e) => {
         const ex = e as ServiceError;
         const errors = parseErrorDetails(ex.metadata);
@@ -205,6 +205,7 @@ export const jobServiceServer = plugin((server) => {
           output,
           errorOutput,
           memory,
+          extraOptions,
         };
 
         const clusterOps = getClusterOps(cluster);

apps/portal-server/tests/job/jobTemplate.test.ts

@@ -40,6 +40,7 @@ const jobInfo = {
   "output": "job.%j.out",
   "errorOutput": "job.%j.err",
   "memory": "750MB",
+  "extraOptions": {},
 };
 const templateId = "testJob-1111";
 
@@ -101,7 +102,7 @@ it("delete job template", async () => {
     cluster, userId, templateId,
   });
 
-  expect(templateInfo?.template).toBeObject();
+  expect(templateInfo?.template?.jobName).toBe("testJob");
 
   await asyncUnaryCall(client, "deleteJobTemplate", {
     cluster, userId, templateId,

apps/portal-web/src/apis/api.mock.ts

@@ -161,6 +161,7 @@ export const mockApi: MockApi<typeof api> = {
       output: "job.%j.out",
       errorOutput: "job.%j.err",
       workingDirectory: "/nfs/jobs/123",
+      extraOptions: {},
     },
   }),
 

apps/portal-web/src/i18n/en.ts

@@ -177,6 +177,7 @@ export default {
         + "the job submission or execution will fail.",
         output: "Standard Output File",
         errorOutput: "Error Output File",
+        k8sImageUrl: "Image Url",
         totalNodeCount: "Total Nodes: ",
         totalGpuCount: "Total GPU Cards: ",
         totalCoreCount: "Total CPU Cores: ",

apps/portal-web/src/i18n/zh_cn.ts

@@ -177,6 +177,7 @@ export default {
 
         output: "标准输出文件",
         errorOutput: "错误输出文件",
+        k8sImageUrl: "镜像地址",
         totalNodeCount: "总节点数：",
         totalGpuCount: "总GPU卡数：",
         totalCoreCount: "总CPU核心数：",

apps/portal-web/src/pageComponents/job/SubmitJobForm.tsx

@@ -44,6 +44,7 @@ interface JobForm {
   output: string;
   errorOutput: string;
   save: boolean;
+  k8sImageUrl: string | undefined;
 }
 
 // 生成默认工作名称，命名规则为年月日-时分秒，如job-20230510-103010
@@ -85,7 +86,7 @@ export const SubmitJobForm: React.FC<Props> = ({ initial = initialValues, submit
 
   const submit = async () => {
     const { cluster, command, jobName, coreCount, gpuCount, workingDirectory, output, errorOutput, save,
-      maxTime, nodeCount, partition, qos, account, comment } = await form.validateFields();
+      maxTime, nodeCount, partition, qos, account, comment, k8sImageUrl } = await form.validateFields();
 
     setLoading(true);
 
@@ -95,6 +96,7 @@ export const SubmitJobForm: React.FC<Props> = ({ initial = initialValues, submit
       gpuCount,
       maxTime, nodeCount, partition, qos, comment,
       workingDirectory, save, memory, output, errorOutput,
+      extraOptions: k8sImageUrl ? { k8sImageUrl } : {},
     } })
       .httpError(500, (e) => {
         if (e.code === "SCHEDULER_FAILED") {
@@ -373,6 +375,19 @@ export const SubmitJobForm: React.FC<Props> = ({ initial = initialValues, submit
             <Input />
           </Form.Item>
         </Col>
+
+        {clusterInfoQuery.data?.clusterInfo.scheduler.name === "k8s" ? (
+          <Col span={24}>
+            <Form.Item
+              label={t(p("k8sImageUrl"))}
+              name="k8sImageUrl"
+              rules={[{ pattern: /^\S+$/, message: "请输入正确的镜像地址" }]}
+            >
+              <Input />
+            </Form.Item>
+          </Col>
+        ) : ""}
+
         <Col className="ant-form-item" span={12} sm={6}>
           {t(p("totalNodeCount"))}{nodeCount}
         </Col>

apps/portal-web/src/pages/api/job/getJobTemplate.ts

@@ -36,6 +36,7 @@ export const JobTemplate = Type.Object({
   output: Type.Optional(Type.String()),
   errorOutput: Type.Optional(Type.String()),
   comment: Type.Optional(Type.String()),
+  extraOptions: Type.Record(Type.String(), Type.String()),
 });
 export type JobTemplate = Static<typeof JobTemplate>;
 

apps/portal-web/src/pages/api/job/submitJob.ts

@@ -39,6 +39,7 @@ export const SubmitJobInfo = Type.Object({
   memory: Type.Optional(Type.String()),
   comment: Type.Optional(Type.String()),
   save: Type.Boolean(),
+  extraOptions: Type.Record(Type.String(), Type.String()),
 });
 
 export type SubmitJobInfo = Static<typeof SubmitJobInfo>;
@@ -72,7 +73,7 @@ export default route(SubmitJobSchema, async (req, res) => {
 
   if (!info) { return; }
 
-  const { cluster, command, jobName, coreCount, gpuCount, maxTime, save,
+  const { cluster, command, jobName, coreCount, gpuCount, maxTime, save, extraOptions,
     nodeCount, partition, qos, account, comment, workingDirectory, output, errorOutput, memory } = req.body;
 
   const client = getClient(JobServiceClient);
@@ -102,6 +103,7 @@ export default route(SubmitJobSchema, async (req, res) => {
     output,
     errorOutput,
     saveAsTemplate: save,
+    extraOptions,
   })
     .then(async ({ jobId }) => {
       await callLog(

apps/portal-web/src/pages/jobs/submit.tsx

@@ -58,6 +58,7 @@ export const SubmitJobPage: NextPage<Props> = requireAuth(() => true)(
               output: template.output,
               errorOutput: template.errorOutput,
               save: false,
+              k8sImageUrl: template.extraOptions.k8sImageUrl,
             }));
         } else {
           return undefined;

docs/docs/deploy/config/cluster-config.md

@@ -55,7 +55,7 @@ crossClusterFileTransfer:
   enabled: true
   # 传输节点的地址(ip地址:端口号)
   transferNode: localhost:22222
-  
+
 ```
 
 ## 注意

protos/portal/job.proto

@@ -73,6 +73,7 @@ message JobTemplate {
   optional string output = 11;
   optional string error_output = 12;
   optional string comment = 13;
+  map<string, string> extra_options = 14;
 }
 
 message ListAllJobsResponse {
@@ -151,6 +152,7 @@ message SubmitJobRequest {
   optional string memory = 15;
   optional string comment = 16;
   bool save_as_template = 17;
+  map<string, string> extra_options = 18;
 }
 
 // NOT_FOUND: cluster is not found