Module deployments_api

Enums

FailDeploymentError

struct for typed errors of method fail_deployment

GetAllocationsForDeploymentError

struct for typed errors of method get_allocations_for_deployment

GetDeploymentError

struct for typed errors of method get_deployment

GetDeploymentsError

struct for typed errors of method get_deployments

PauseDeploymentError

struct for typed errors of method pause_deployment

PromoteDeploymentError

struct for typed errors of method promote_deployment

SetAllocationHealthInDeploymentError

struct for typed errors of method set_allocation_health_in_deployment

Functions

fail_deployment

get_allocations_for_deployment

get_deployment

get_deployments

pause_deployment

promote_deployment

set_allocation_health_in_deployment

In some use cases, automatic detection of allocation health may not be desired. As such those task groups can be marked with an upgrade policy that uses health_check = "manual". Those allocations must have their health marked manually using this endpoint. Marking an allocation as healthy will allow the rolling upgrade to proceed. Marking it as failed will cause the deployment to fail. This endpoint only triggers a rollback if the most recent stable version of the job has a different specification than the job being reverted