DigitalOcean Create
CertifiedCreate a DigitalOcean load balancer
DigitalOcean Create
Create a DigitalOcean load balancer
Creates a new load balancer with at least one forwarding rule, optionally attached to a set of droplets.
type: io.kestra.plugin.digitalocean.loadbalancer.CreateExamples
Create a load balancer forwarding HTTP traffic to a set of droplets
id: digitalocean_create_load_balancer
namespace: company.team
tasks:
- id: create_load_balancer
type: io.kestra.plugin.digitalocean.loadbalancer.Create
apiToken: "{{ secret('DIGITALOCEAN_TOKEN') }}"
name: "web-lb"
region: "nyc3"
forwardingRules:
- entryProtocol: "http"
entryPort: 80
targetProtocol: "http"
targetPort: 80
dropletIds:
- 3164444
- 3164445
Properties
apiToken *Requiredstring
DigitalOcean API token
Personal access token used to authenticate against the DigitalOcean API v2, sent as Authorization: Bearer <token>. Create one (prefixed dop_v1_) in the DigitalOcean control panel under API > Tokens, and store it as a Kestra secret.
forwardingRules *Requiredarray
Forwarding rules
At least one forwarding rule, each with entryProtocol, entryPort, targetProtocol, targetPort, and optional certificateId and tlsPassthrough.
io.kestra.plugin.digitalocean.loadbalancer.ForwardingRule
Entry port
Port accepted on the load balancer's public-facing side.
Entry protocol
Protocol accepted on the load balancer's public-facing side, e.g. http, https, tcp, or udp.
Target port
Port used to reach the backend droplets.
Target protocol
Protocol used to reach the backend droplets, e.g. http, https, tcp, or udp.
Certificate ID
UUID of the DigitalOcean-managed or custom certificate used for HTTPS/TLS termination on this rule.
TLS passthrough
Whether encrypted traffic is passed through to the backend without being decrypted by the load balancer.
name *Requiredstring
Load balancer name
Human-readable name for the load balancer, must be unique on the account.
region *Requiredstring
Region
Datacenter region slug to create the load balancer in, e.g. nyc3, ams3, sgp1.
baseUrl string
https://api.digitalocean.comDigitalOcean API base URL
Base endpoint for all DigitalOcean API calls. Defaults to https://api.digitalocean.com.
dropletIds array
Droplet IDs
Numeric IDs of the droplets to attach to the load balancer.
options Non-dynamic
HTTP client options
Optional HTTP configuration (timeouts, proxy, SSL) applied to every DigitalOcean API call.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
id string
Load balancer ID
UUID assigned by DigitalOcean.
ip string
Public IP address
name string
Load balancer name
region string
Region slug
Datacenter region the load balancer runs in, e.g. nyc3.
status string
Status
One of new, active, or errored.
