Appearance
Timeouts
The Deployer creates, or updates, different cloud resources. The duration of each operation depends on different factors like the resource type or the cloud provider and its current load in the selected region. Therefore the installer polls for the completion of its action, regularly checking for progress. To avoid checking forever, different timeouts have been implemented.
The default timeout values have been designed for observed behaviours and should be large enough to allow operations to complete. However in exceptional situations is could be useful to increase those values. Customisation settings have been implemented in the installer configuration to enable this. It is recommended to change the timeout values only when issues are encountered, and rely on the default settings as much as possible.
Timeout customisation and format
Customisation of the timeouts can be performed through specific fields in the installer configuration file, using a string format representing a duration. A duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as 300ms
, 1.5h
or 2h45m
. Valid time units are ns
, us
(or µs
), ms
, s
, m
, h
. The location of each override option below is described as a JSON Path that can be altered in the configuration file, for example network.timeout
corresponds to a JSON document such as:
{
"network": {
"timeout": "15m"
}
}
List of Timeout Values and JSON Paths
Action | Default Timeout | Override Option |
---|---|---|
Creation or deletion of a VPC | 10m | network.timeout |
Creation or deletion of a registry | 10m | registry.timeout |
Upload of all the container images | 1h | registry.timeout |
Creation or deletion of a k8s cluster | 1h | kubernetes.timeout |
Deployment of a third party dependency | 5m | dependencies.timeout |
Deployment of the Yellowbrick Operator | 15m | operator.timeout |
Deployment of the Yellowbrick Instance | 15m | instance.timeout |
Deployment of the Yellowbrick Manager | 15m | instance.timeout |