Clever Cloud WaitForState
CertifiedWait for a Clever Cloud deployment to reach a target state
Clever Cloud WaitForState
Wait for a Clever Cloud deployment to reach a target state
Polls a deployment at a configurable interval until it reaches one of the terminal states (OK, FAIL, CANCELLED) or the specified target state.
WIP means the deployment is still in progress. A successful deployment has state OK and action DEPLOY.
By default the task never fails: if the deployment reaches a terminal state other than the target, or the timeout elapses, it logs a warning and returns the last observed state with reachedTarget set to false. Set failOnUnreached to true to throw instead.
When organisationId is omitted, the personal account endpoint (/self) is used.
type: io.kestra.plugin.clevercloud.deployments.WaitForStateExamples
Wait until a deployment succeeds
id: wait_deployment
namespace: company.team
tasks:
- id: wait
type: io.kestra.plugin.clevercloud.deployments.WaitForState
apiToken: "{{ secret('CC_API_TOKEN') }}"
organisationId: "orga_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
applicationId: "app_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
deploymentId: "{{ inputs.deploymentId }}"
pollInterval: PT10S
timeout: PT10M
Properties
apiToken *Requiredstring
API token
Bearer token for the Clever Cloud API. Store as a Kestra secret and reference with {{ secret('CC_API_TOKEN') }}.
applicationId *Requiredstring
Application ID
deploymentId *Requiredstring
Deployment ID to watch
failOnUnreached booleanstring
falseFail the task if the target state is not reached
When false (the default), the task logs a warning and returns the last observed state instead of failing if the deployment reaches a different terminal state or the timeout elapses. When true, the task throws in both cases.
options Non-dynamic
HTTP client options
Optional HttpConfiguration applied to every Clever Cloud API call, including timeouts and proxy settings.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
organisationId string
Organisation ID
When omitted, the personal account endpoint (/self) is used instead.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
pollInterval string
PT15SHow often to poll the deployment status
ISO-8601 duration, e.g. PT10S for 10 seconds. Defaults to 15 seconds.
targetState string
OKWIPOKFAILCANCELLEDTarget state to wait for
Accepts: OK (deployment succeeded), FAIL (deployment errored), CANCELLED (deployment cancelled), WIP (still in progress, not a terminal state). Defaults to OK, the state of a successful deploy.
timeout string
PT30MMaximum time to wait before aborting
ISO-8601 duration, e.g. PT10M for 10 minutes. Defaults to 30 minutes.
Outputs
deploymentId string
Deployment ID that was polled
reachedTarget boolean
falseWhether the configured targetState was reached
state string
Final state when the task completed
