add optional environment variables field to all models

Author: andrii-i

jupyter_scheduler/models.py

@@ -77,6 +77,7 @@ class CreateJob(BaseModel):
     input_filename: str = None
     runtime_environment_name: str
     runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
+    environment_variables: Optional[Dict[str, str]] = None
     output_formats: Optional[List[str]] = None
     idempotency_token: Optional[str] = None
     job_definition_id: Optional[str] = None
@@ -128,6 +129,7 @@ class DescribeJob(BaseModel):
     input_filename: str = None
     runtime_environment_name: str
     runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
+    environment_variables: Optional[Dict[str, str]] = None
     output_formats: Optional[List[str]] = None
     idempotency_token: Optional[str] = None
     job_definition_id: Optional[str] = None
@@ -193,6 +195,7 @@ class UpdateJob(BaseModel):
     status: Optional[Status] = None
     name: Optional[str] = None
     compute_type: Optional[str] = None
+    environment_variables: Optional[Dict[str, str]] = None
 
 
 class DeleteJob(BaseModel):
@@ -204,6 +207,7 @@ class CreateJobDefinition(BaseModel):
     input_filename: str = None
     runtime_environment_name: str
     runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
+    environment_variables: Optional[Dict[str, str]] = None
     output_formats: Optional[List[str]] = None
     parameters: Optional[Dict[str, str]] = None
     tags: Optional[Tags] = None
@@ -226,6 +230,7 @@ class DescribeJobDefinition(BaseModel):
     input_filename: str = None
     runtime_environment_name: str
     runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
+    environment_variables: Optional[Dict[str, str]] = None
     output_formats: Optional[List[str]] = None
     parameters: Optional[Dict[str, str]] = None
     tags: Optional[Tags] = None
@@ -248,6 +253,7 @@ class Config:
 class UpdateJobDefinition(BaseModel):
     runtime_environment_name: Optional[str]
     runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
+    environment_variables: Optional[Dict[str, str]] = None
     output_formats: Optional[List[str]] = None
     parameters: Optional[Dict[str, str]] = None
     tags: Optional[Tags] = None

jupyter_scheduler/orm.py

@@ -89,6 +89,7 @@ class CommonColumns:
     # Any default values specified for new columns will be ignored during the migration process.
     package_input_folder = Column(Boolean)
     packaged_files = Column(JsonType, default=[])
+    environment_variables = Column(JsonType(4096))
 
 
 class Job(CommonColumns, Base):

src/handler.ts

@@ -364,6 +364,7 @@ export namespace Scheduler {
     schedule?: string;
     timezone?: string;
     package_input_folder?: boolean;
+    environment_variables?: { [key: string]: string };
   }
 
   export interface IUpdateJobDefinition {
@@ -418,6 +419,7 @@ export namespace Scheduler {
     output_formats?: string[];
     compute_type?: string;
     package_input_folder?: boolean;
+    environment_variables?: { [key: string]: string };
   }
 
   export interface ICreateJobFromDefinition {

src/mainviews/create-job.tsx

@@ -322,7 +322,8 @@ export function CreateJob(props: ICreateJobProps): JSX.Element {
       idempotency_token: props.model.idempotencyToken,
       tags: props.model.tags,
       runtime_environment_parameters: props.model.runtimeEnvironmentParameters,
-      package_input_folder: props.model.packageInputFolder
+      package_input_folder: props.model.packageInputFolder,
+      environment_variables: props.model.environmentVariables
     };
 
     if (props.model.parameters !== undefined) {
@@ -371,7 +372,8 @@ export function CreateJob(props: ICreateJobProps): JSX.Element {
       runtime_environment_parameters: props.model.runtimeEnvironmentParameters,
       schedule: props.model.schedule,
       timezone: props.model.timezone,
-      package_input_folder: props.model.packageInputFolder
+      package_input_folder: props.model.packageInputFolder,
+      environment_variables: props.model.environmentVariables
     };
 
     if (props.model.parameters !== undefined) {

src/model.ts

@@ -100,6 +100,7 @@ export interface ICreateJobModel
   // Is the create button disabled due to a submission in progress?
   createInProgress?: boolean;
   packageInputFolder?: boolean;
+  environmentVariables?: { [key: string]: string };
 }
 
 export const defaultScheduleFields: ModelWithScheduleFields = {