Reference
App Parameters
Setting Parameters
Parameters can be set using the following command.
convox apps params set Foo=Yes Baz=No
When a Rack update adds new app parameters they become available for each app after its next deploy.
AutoMinorVersionUpgrade
Set to false
to disable the automatic minor version upgrade of any database resources in this app. Defaults to true
.
CircuitBreaker
Set to Yes
to enable Circuit Breaker deployments in ECS. This will make failing deployments rollback quicker and easier. If a deployment requires your Rack to scale up however, it can trip the Circuit Breaker and fail when it otherwise wouldn’t. Best used when you have good capacity on your Rack.
FargateServices
Set to Yes
to run all services for this application in Fargate. Set to Spot
to run all services for this application in Fargate Spot.
FargateTimers
Set to Yes
to run all timers for this application in Fargate. Set to Spot
to run all timers for this application in Fargate Spot.
IamPolicy
Specify the ARN of a custom IAM policy to add the the Service’s Task Role at runtime. Unless the service has the Policies parameter set, then it will not be used at service level.
InternalDomains
Set to No
to disable the internal domain names at convox.site
and .convox
to from routing to this application. You can use this parameter if you are running out of available rules on your load balancer.
LoadBalancerAlgorithm
Sets the routing algorithm used for the services within the application. Defaults to round_robin
, but you can also set to least_outstanding_requests
.
LoadBalancerSuccessCodes
Specifies the HTTP codes that healthy targets must use when responding to an HTTP health check. You can specify values between 200 and 499, and the default value is 200-399,401
. You can specify multiple values (for example, 200,202
) or a range of values (for example, 200-299
).
LoadBalancerGrpcSuccessCodes
Specifies the GRPC codes that healthy targets must use when responding to an GRPC health check. You can specify values between 0 and 99, and the default value is \“12\”. You can specify multiple values (for example, \“12,13\”) or a range of values (for example, \“10-99\”).
LogRetention
Set to the number of days you wish to retain logs for. The default for new applications is 7
. Setting the retention window to a high/unlimited value will affect the performance/reliability of convox logs
over the long term. It is recommended to keep it at a smaller value and use syslog to export your logs for long-term archival and analysis.
RedirectHttps
Set to No
to allow the app to listen on HTTP rather than the default behavior of having all HTTP requests automatically redirected to HTTPS.
SlowStartDuration
Sets the ramp up period during which a newly deployed service will receive a gradually increasing share of traffic. Defaults to 0 seconds (disabled). Other valid values are between 30-900 seconds. Once the duration has expired, the full share of traffic will be directed at the newly deployed service.
TaskTags
Set to Yes
to cause ECS tags to be propagated to the task level.