Service Configuration
Web Services
The following is a full reference for all the fields that can be set for a web service in porter.yaml
.
- autoscaling - the autoscaling configuration for the service.
- enabled - whether autoscaling is enabled or not.
- minInstances - the minimum number of instances to run.
- maxInstances - the maximum number of instances to run.
- cpuThresholdPercent - the CPU threshold percentage to trigger autoscaling at.
- memoryThresholdPercent - the memory threshold percentage to trigger autoscaling at.
- domains - the list of custom domains for the service, if the service is exposed publicly.
- name - the name of the domain.
- private - whether the service is private or not.
- healthCheck - the health check configuration for the service.
- enabled - whether the health check is enabled or not.
- httpPath - the path to check for the health check.
- ingressAnnotations - the ingress annotations to apply for the service.
- pathRouting - the list of URL paths to service port mappings, if path-based routing is enabled.
Note that a path must be specified for the default port (set in services.port).
If routing to a port on a different service, the port must be exposed on that service (either as the default port or through a path routing rule).
- path - the URL path.
- port - the port to route to.
- appName - (optional) the name of the application to route to (as it appears in the dashboard). Defaults to the application of the current service.
- serviceName - (optional) the name of the service to route to (as it appears in the dashboard). Defaults to the current service. Must be specified if appName is set.
- rewriteCustomPaths - when path routing is enabled, whether to rewrite custom paths to the root path. Defaults to true.
autoscaling
object
- optional
All fields are optional.
domains
array
- optional
private
boolean
- optional
healthCheck
object
- optional
ingressAnnotations
object
- optional
pathRouting
array
- optional
rewriteCustomPaths
boolean
- optional (defaults to true)