Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(Deployments): support Job Variables #250

Merged
merged 3 commits into from
Aug 27, 2024
Merged

feat(Deployments): support Job Variables #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab0eeff
feat(Deployments): support Job Variables
felixpelletier Aug 26, 2024
309ab47
Use 'env' key for job_variables test and example
mitchnielsen Aug 26, 2024
8745401
Address golangci-lint var naming changes
mitchnielsen Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/resources/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ resource "prefect_deployment" "deployment" {
entrypoint = "hello_world.py:hello_world"
tags = ["test"]
enforce_parameter_schema = false
manifest_path = "./bar/foo"
job_variables = jsonencode({
"env" : { "some-key" : "some-value" }
})
manifest_path = "./bar/foo"
parameters = jsonencode({
"some-parameter" : "some-value",
"some-parameter2" : "some-value2"
Expand All @@ -59,6 +62,7 @@ resource "prefect_deployment" "deployment" {
- `description` (String) A description for the deployment.
- `enforce_parameter_schema` (Boolean) Whether or not the deployment should enforce the parameter schema.
- `entrypoint` (String) The path to the entrypoint for the workflow, relative to the path.
- `job_variables` (String) Overrides for the flow's infrastructure configuration.
- `manifest_path` (String) The path to the flow's manifest file, relative to the chosen storage.
- `parameters` (String) Parameters for flow runs scheduled by the deployment.
- `path` (String) The path to the working directory for the workflow, relative to remote storage or an absolute path.
Expand Down
5 changes: 4 additions & 1 deletion examples/resources/prefect_deployment/resource.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ resource "prefect_deployment" "deployment" {
entrypoint = "hello_world.py:hello_world"
tags = ["test"]
enforce_parameter_schema = false
manifest_path = "./bar/foo"
job_variables = jsonencode({
"env" : { "some-key" : "some-value" }
})
manifest_path = "./bar/foo"
parameters = jsonencode({
"some-parameter" : "some-value",
"some-parameter2" : "some-value2"
Expand Down
3 changes: 3 additions & 0 deletions internal/api/deployments.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ type Deployment struct {
EnforceParameterSchema bool `json:"enforce_parameter_schema"`
Entrypoint string `json:"entrypoint"`
FlowID uuid.UUID `json:"flow_id"`
JobVariables map[string]interface{} `json:"job_variables,omitempty"`
ManifestPath string `json:"manifest_path,omitempty"`
Name string `json:"name"`
Parameters map[string]interface{} `json:"parameters,omitempty"`
Expand All @@ -42,6 +43,7 @@ type DeploymentCreate struct {
EnforceParameterSchema bool `json:"enforce_parameter_schema,omitempty"`
Entrypoint string `json:"entrypoint,omitempty"`
FlowID uuid.UUID `json:"flow_id"`
JobVariables map[string]interface{} `json:"job_variables,omitempty"`
ManifestPath string `json:"manifest_path,omitempty"`
Name string `json:"name"`
Parameters map[string]interface{} `json:"parameters,omitempty"`
Expand All @@ -58,6 +60,7 @@ type DeploymentUpdate struct {
Description string `json:"description,omitempty"`
EnforceParameterSchema bool `json:"enforce_parameter_schema,omitempty"`
Entrypoint string `json:"entrypoint,omitempty"`
JobVariables map[string]interface{} `json:"job_variables,omitempty"`
ManifestPath string `json:"manifest_path"`
Parameters map[string]interface{} `json:"parameters,omitempty"`
Path string `json:"path,omitempty"`
Expand Down
49 changes: 42 additions & 7 deletions internal/provider/resources/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ type DeploymentResourceModel struct {
EnforceParameterSchema types.Bool `tfsdk:"enforce_parameter_schema"`
Entrypoint types.String `tfsdk:"entrypoint"`
FlowID customtypes.UUIDValue `tfsdk:"flow_id"`
JobVariables jsontypes.Normalized `tfsdk:"job_variables"`
ManifestPath types.String `tfsdk:"manifest_path"`
Name types.String `tfsdk:"name"`
Parameters jsontypes.Normalized `tfsdk:"parameters"`
Expand Down Expand Up @@ -163,6 +164,12 @@ func (r *DeploymentResource) Schema(_ context.Context, _ resource.SchemaRequest,
stringplanmodifier.UseStateForUnknown(),
},
},
"job_variables": schema.StringAttribute{
Description: "Overrides for the flow's infrastructure configuration.",
Optional: true,
Computed: true,
CustomType: jsontypes.NormalizedType{},
},
"work_queue_name": schema.StringAttribute{
Description: "The work queue for the deployment. If no work queue is set, work will not be scheduled.",
Optional: true,
Expand Down Expand Up @@ -279,8 +286,14 @@ func (r *DeploymentResource) Create(ctx context.Context, req resource.CreateRequ
return
}

var data map[string]interface{}
resp.Diagnostics.Append(plan.Parameters.Unmarshal(&data)...)
var parameters map[string]interface{}
resp.Diagnostics.Append(plan.Parameters.Unmarshal(&parameters)...)
if resp.Diagnostics.HasError() {
return
}

var jobVariables map[string]interface{}
resp.Diagnostics.Append(plan.JobVariables.Unmarshal(&jobVariables)...)
if resp.Diagnostics.HasError() {
return
}
Expand All @@ -290,9 +303,10 @@ func (r *DeploymentResource) Create(ctx context.Context, req resource.CreateRequ
EnforceParameterSchema: plan.EnforceParameterSchema.ValueBool(),
Entrypoint: plan.Entrypoint.ValueString(),
FlowID: plan.FlowID.ValueUUID(),
JobVariables: jobVariables,
ManifestPath: plan.ManifestPath.ValueString(),
Name: plan.Name.ValueString(),
Parameters: data,
Parameters: parameters,
Path: plan.Path.ValueString(),
Paused: plan.Paused.ValueBool(),
Tags: tags,
Expand Down Expand Up @@ -371,11 +385,17 @@ func (r *DeploymentResource) Read(ctx context.Context, req resource.ReadRequest,
return
}

byteSlice, err := json.Marshal(deployment.Parameters)
parametersByteSlice, err := json.Marshal(deployment.Parameters)
if err != nil {
resp.Diagnostics.Append(helpers.SerializeDataErrorDiagnostic("parameters", "Deployment parameters", err))
}
model.Parameters = jsontypes.NewNormalizedValue(string(byteSlice))
model.Parameters = jsontypes.NewNormalizedValue(string(parametersByteSlice))

jobVariablesByteSlice, err := json.Marshal(deployment.JobVariables)
if err != nil {
resp.Diagnostics.Append(helpers.SerializeDataErrorDiagnostic("job_variables", "Deployment job variables", err))
}
model.JobVariables = jsontypes.NewNormalizedValue(string(jobVariablesByteSlice))

resp.Diagnostics.Append(resp.State.Set(ctx, &model)...)
if resp.Diagnostics.HasError() {
Expand Down Expand Up @@ -423,10 +443,17 @@ func (r *DeploymentResource) Update(ctx context.Context, req resource.UpdateRequ
return
}

var jobVariables map[string]interface{}
resp.Diagnostics.Append(model.JobVariables.Unmarshal(&jobVariables)...)
if resp.Diagnostics.HasError() {
return
}

payload := api.DeploymentUpdate{
Description: model.Description.ValueString(),
EnforceParameterSchema: model.EnforceParameterSchema.ValueBool(),
Entrypoint: model.Entrypoint.ValueString(),
JobVariables: jobVariables,
ManifestPath: model.ManifestPath.ValueString(),
Parameters: parameters,
Path: model.Path.ValueString(),
Expand Down Expand Up @@ -462,13 +489,21 @@ func (r *DeploymentResource) Update(ctx context.Context, req resource.UpdateRequ
return
}

byteSlice, err := json.Marshal(deployment.Parameters)
parametersByteSlice, err := json.Marshal(deployment.Parameters)
if err != nil {
resp.Diagnostics.Append(helpers.SerializeDataErrorDiagnostic("parameters", "Deployment parameters", err))

return
}
model.Parameters = jsontypes.NewNormalizedValue(string(byteSlice))
model.Parameters = jsontypes.NewNormalizedValue(string(parametersByteSlice))

jobVariablesByteSlice, err := json.Marshal(deployment.JobVariables)
if err != nil {
resp.Diagnostics.Append(helpers.SerializeDataErrorDiagnostic("job_variables", "Deployment job variables", err))

return
}
model.JobVariables = jsontypes.NewNormalizedValue(string(jobVariablesByteSlice))

resp.Diagnostics.Append(resp.State.Set(ctx, &model)...)
if resp.Diagnostics.HasError() {
Expand Down
8 changes: 8 additions & 0 deletions internal/provider/resources/deployment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ type deploymentConfig struct {
Description string
EnforceParameterSchema bool
Entrypoint string
JobVariables string
ManifestPath string
Parameters string
Path string
Expand Down Expand Up @@ -54,6 +55,9 @@ resource "prefect_deployment" "{{.DeploymentName}}" {
enforce_parameter_schema = {{.EnforceParameterSchema}}
entrypoint = "{{.Entrypoint}}"
flow_id = prefect_flow.{{.FlowName}}.id
job_variables = jsonencode(
{{.JobVariables}}
)
manifest_path = "{{.ManifestPath}}"
parameters = jsonencode({
"some-parameter": "{{.Parameters}}"
Expand Down Expand Up @@ -87,6 +91,7 @@ func TestAccResource_deployment(t *testing.T) {
Description: "My deployment description",
EnforceParameterSchema: false,
Entrypoint: "hello_world.py:hello_world",
JobVariables: `{"env":{"some-key":"some-value"}}`,
ManifestPath: "some-manifest-path",
Parameters: "some-value1",
Path: "some-path",
Expand All @@ -110,6 +115,7 @@ func TestAccResource_deployment(t *testing.T) {
// Configure new values to test the update.
Description: "My deployment description v2",
Entrypoint: "hello_world.py:hello_world2",
JobVariables: `{"env":{"some-key":"some-value2"}}`,
ManifestPath: "some-manifest-path2",
Parameters: "some-value2",
Path: "some-path2",
Expand Down Expand Up @@ -150,6 +156,7 @@ func TestAccResource_deployment(t *testing.T) {
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "description", cfgCreate.Description),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "enforce_parameter_schema", strconv.FormatBool(cfgCreate.EnforceParameterSchema)),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "entrypoint", cfgCreate.Entrypoint),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "job_variables", cfgCreate.JobVariables),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "manifest_path", cfgCreate.ManifestPath),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "parameters", `{"some-parameter":"some-value1"}`),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "path", cfgCreate.Path),
Expand All @@ -175,6 +182,7 @@ func TestAccResource_deployment(t *testing.T) {
resource.TestCheckResourceAttr(cfgUpdate.DeploymentResourceName, "description", cfgUpdate.Description),
resource.TestCheckResourceAttr(cfgUpdate.DeploymentResourceName, "enforce_parameter_schema", strconv.FormatBool(cfgUpdate.EnforceParameterSchema)),
resource.TestCheckResourceAttr(cfgUpdate.DeploymentResourceName, "entrypoint", cfgUpdate.Entrypoint),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "job_variables", cfgUpdate.JobVariables),
resource.TestCheckResourceAttr(cfgUpdate.DeploymentResourceName, "manifest_path", cfgUpdate.ManifestPath),
resource.TestCheckResourceAttr(cfgCreate.DeploymentResourceName, "parameters", `{"some-parameter":"some-value2"}`),
resource.TestCheckResourceAttr(cfgUpdate.DeploymentResourceName, "path", cfgUpdate.Path),
Expand Down
Loading