feat(deployment): add basic Deployment resource

docs/resources/deployment.md

@@ -0,0 +1,83 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "prefect_deployment Resource - prefect"
+subcategory: ""
+description: |-
+  Deployments are server-side representations of flows. They store the crucial metadata needed for remote orchestration including when, where, and how a workflow should run. Deployments elevate workflows from functions that you must call manually to API-managed entities that can be triggered remotely.
+---
+
+# prefect_deployment (Resource)
+
+Deployments are server-side representations of flows. They store the crucial metadata needed for remote orchestration including when, where, and how a workflow should run. Deployments elevate workflows from functions that you must call manually to API-managed entities that can be triggered remotely.
+
+## Example Usage
+
+```terraform
+resource "prefect_workspace" "workspace" {
+  handle = "my-workspace"
+  name   = "my-workspace"
+}
+
+resource "prefect_flow" "flow" {
+  name         = "my-flow"
+  workspace_id = prefect_workspace.workspace.id
+  tags         = ["tf-test"]
+}
+
+resource "prefect_deployment" "deployment" {
+  name                     = "%s"
+  description              = "string"
+  workspace_id             = prefect_workspace.workspace.id
+  flow_id                  = prefect_flow.flow.id
+  entrypoint               = "hello_world.py:hello_world"
+  tags                     = ["test"]
+  enforce_parameter_schema = false
+  manifest_path            = "./bar/foo"
+  path                     = "./foo/bar"
+  paused                   = false
+  version                  = "v1.1.1"
+  work_pool_name           = "mitch-testing-pool"
+  work_queue_name          = "default"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `flow_id` (String) Flow ID (UUID) to associate deployment to
+- `name` (String) Name of the workspace
+
+### Optional
+
+- `account_id` (String) Account ID (UUID), defaults to the account set in the provider
+- `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.
+- `manifest_path` (String) The path to the flow's manifest file, relative to the chosen storage.
+- `path` (String) The path to the working directory for the workflow, relative to remote storage or an absolute path.
+- `paused` (Boolean) Whether or not the deployment is paused.
+- `tags` (List of String) Tags associated with the deployment
+- `version` (String) An optional version for the deployment.
+- `work_pool_name` (String) The name of the deployment's work pool.
+- `work_queue_name` (String) The work queue for the deployment. If no work queue is set, work will not be scheduled.
+- `workspace_id` (String) Workspace ID (UUID) to associate deployment to
+
+### Read-Only
+
+- `created` (String) Timestamp of when the resource was created (RFC3339)
+- `id` (String) Workspace ID (UUID)
+- `updated` (String) Timestamp of when the resource was updated (RFC3339)
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Prefect Deployments can be imported via deployment_id
+terraform import prefect_deployment.example 00000000-0000-0000-0000-000000000000
+
+# or via deployment_id,workspace_id
+terraform import prefect_deployment.example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000
+```

docs/resources/flow.md

@@ -50,5 +50,5 @@ Import is supported using the following syntax:
 
 ```shell
 # Prefect Flows can be imported via flow_id,workspace_id
-terraform import prefect_variable.example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000
+terraform import prefect_flow.example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000
 ```

examples/resources/prefect_deployment/import.sh

@@ -0,0 +1,5 @@
+# Prefect Deployments can be imported via deployment_id
+terraform import prefect_deployment.example 00000000-0000-0000-0000-000000000000
+
+# or via deployment_id,workspace_id
+terraform import prefect_deployment.example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000

examples/resources/prefect_deployment/resource.tf

@@ -0,0 +1,27 @@
+resource "prefect_workspace" "workspace" {
+  handle = "my-workspace"
+  name   = "my-workspace"
+}
+
+resource "prefect_flow" "flow" {
+  name         = "my-flow"
+  workspace_id = prefect_workspace.workspace.id
+  tags         = ["tf-test"]
+}
+
+resource "prefect_deployment" "deployment" {
+  name                     = "my-deployment"
+  description              = "string"
+  workspace_id             = prefect_workspace.workspace.id
+  flow_id                  = prefect_flow.flow.id
+  entrypoint               = "hello_world.py:hello_world"
+  tags                     = ["test"]
+  enforce_parameter_schema = false
+  manifest_path            = "./bar/foo"
+  path                     = "./foo/bar"
+  paused                   = false
+  version                  = "v1.1.1"
+  work_pool_name           = "mitch-testing-pool"
+  work_queue_name          = "default"
+}
+

examples/resources/prefect_flow/import.sh

@@ -1,2 +1,2 @@
 # Prefect Flows can be imported via flow_id,workspace_id
-terraform import prefect_variable.example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000
+terraform import prefect_flow.example 00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000

examples/resources/prefect_flow/resource.tf

@@ -7,4 +7,5 @@ resource "prefect_flow" "flow" {
   name         = "my-flow"
   workspace_id = prefect_workspace.workspace.id
   tags         = ["tf-test"]
-}
+}
+

internal/api/client.go

@@ -13,6 +13,7 @@ type PrefectClient interface {
 	BlockSchemas(accountID uuid.UUID, workspaceID uuid.UUID) (BlockSchemaClient, error)
 	BlockTypes(accountID uuid.UUID, workspaceID uuid.UUID) (BlockTypeClient, error)
 	Collections() (CollectionsClient, error)
+	Deployments(accountID uuid.UUID, workspaceID uuid.UUID) (DeploymentsClient, error)
 	Teams(accountID uuid.UUID) (TeamsClient, error)
 	Flows(accountID uuid.UUID, workspaceID uuid.UUID) (FlowsClient, error)
 	Workspaces(accountID uuid.UUID) (WorkspacesClient, error)

internal/api/deployments.go

@@ -0,0 +1,110 @@
+package api
+
+import (
+	"context"
+
+	"github.com/google/uuid"
+)
+
+// DeploymentsClient is a client for working with deployemts.
+type DeploymentsClient interface {
+	Create(ctx context.Context, data DeploymentCreate) (*Deployment, error)
+	Get(ctx context.Context, deploymentID uuid.UUID) (*Deployment, error)
+	List(ctx context.Context, handleNames []string) ([]*Deployment, error)
+	Update(ctx context.Context, deploymentID uuid.UUID, data DeploymentUpdate) error
+	Delete(ctx context.Context, deploymentID uuid.UUID) error
+}
+
+// Deployment is a representation of a deployment.
+type Deployment struct {
+	BaseModel
+	AccountID   uuid.UUID `json:"account_id"`
+	WorkspaceID uuid.UUID `json:"workspace_id"`
+
+	Description            string    `json:"description,omitempty"`
+	EnforceParameterSchema bool      `json:"enforce_parameter_schema"`
+	Entrypoint             string    `json:"entrypoint"`
+	FlowID                 uuid.UUID `json:"flow_id"`
+	ManifestPath           string    `json:"manifest_path,omitempty"`
+	Name                   string    `json:"name"`
+	Path                   string    `json:"path"`
+	Paused                 bool      `json:"paused"`
+	Tags                   []string  `json:"tags"`
+	Version                string    `json:"version,omitempty"`
+	WorkPoolName           string    `json:"work_pool_name,omitempty"`
+	WorkQueueName          string    `json:"work_queue_name,omitempty"`
+}
+
+// DeploymentCreate is a subset of Deployment used when creating deployments.
+type DeploymentCreate struct {
+	Description            string    `json:"description,omitempty"`
+	EnforceParameterSchema bool      `json:"enforce_parameter_schema,omitempty"`
+	Entrypoint             string    `json:"entrypoint,omitempty"`
+	FlowID                 uuid.UUID `json:"flow_id"`
+	ManifestPath           string    `json:"manifest_path,omitempty"`
+	Name                   string    `json:"name"`
+	Path                   string    `json:"path,omitempty"`
+	Paused                 bool      `json:"paused,omitempty"`
+	Tags                   []string  `json:"tags,omitempty"`
+	Version                string    `json:"version,omitempty"`
+	WorkPoolName           string    `json:"work_pool_name,omitempty"`
+	WorkQueueName          string    `json:"work_queue_name,omitempty"`
+}
+
+// DeploymentUpdate is a subset of Deployment used when updating deployments.
+type DeploymentUpdate struct {
+	Description            string   `json:"description,omitempty"`
+	EnforceParameterSchema bool     `json:"enforce_parameter_schema,omitempty"`
+	Entrypoint             string   `json:"entrypoint,omitempty"`
+	ManifestPath           string   `json:"manifest_path"`
+	Path                   string   `json:"path,omitempty"`
+	Paused                 bool     `json:"paused,omitempty"`
+	Tags                   []string `json:"tags,omitempty"`
+	Version                string   `json:"version,omitempty"`
+	WorkPoolName           string   `json:"work_pool_name,omitempty"`
+	WorkQueueName          string   `json:"work_queue_name,omitempty"`
+}
+
+// DeploymentFilter defines the search filter payload
+// when searching for deployements by name.
+// example request payload:
+// {"deployments": {"handle": {"any_": ["test"]}}}.
+type DeploymentFilter struct {
+}
+
+type DeploymentAccess struct {
+	BaseModel
+	AccountID     uuid.UUID               `json:"account_id"`
+	WorkspaceID   uuid.UUID               `json:"workspace_id"`
+	DeploymentID  uuid.UUID               `json:"deployment_id"`
+	AccessControl DeploymentAccessControl `json:"access_control"`
+}
+
+// DeploymentAccessSet is a subset of DeploymentAccess used when Setting deployment access control.
+type DeploymentAccessSet struct {
+	AccessControl DeploymentAccessControlSet `json:"access_control"`
+}
+
+// DeploymentAccessControlSet is a definition of deployment access control.
+type DeploymentAccessControlSet struct {
+	ManageActorIDs []string `json:"manage_actor_ids"`
+	RunActorIDs    []string `json:"run_actor_ids"`
+	ViewActorIDs   []string `json:"view_actor_ids"`
+	ManageTeamIDs  []string `json:"manage_team_ids"`
+	RunTeamIDs     []string `json:"run_team_ids"`
+	ViewTeamIDs    []string `json:"view_team_ids"`
+}
+
+// DeploymentAccessControl is a definition of deployment access control.
+type DeploymentAccessControl struct {
+	ManageActors []Actor `json:"manage_actors"`
+	RunActors    []Actor `json:"run_actors"`
+	ViewActors   []Actor `json:"view_actors"`
+}
+
+type Actor struct {
+	ID    uuid.UUID `json:"id"`
+	Name  string    `json:"name"`
+	Email string    `json:"email"`
+	Type  string    `json:"type"`
+}