Runway on Kubernetes Service Configuration Schema

Type: object

Schema for validating Runway on Kubernetes Service values.yaml files

 No Additional Properties

root apiVersion
Type: string

API version for the Runway service configuration

Must match regular expression: ^runway/v[1-9][0-9]*$

root kind
Type: enum (of string)

Resource kind, must be RunwayKubernetesService

Must be one of:

  • "RunwayKubernetesService"

root metadata
Type: object
No Additional Properties

root metadata name
Type: string

Name of the service following Kubernetes naming conventions

Must match regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Must be at most 63 characters long

root spec
Type: object
No Additional Properties

root spec image
Type: string

Container image with {{ .AppVersion }} tag placeholder

Must match regular expression: ^.*\{\{ \.AppVersion \}\}$

root spec command
Type: array of string

Command to run in the container

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root spec command command items
Type: string

root spec environment
Type: object

Environment variables for the service

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z_][A-Z0-9_]*$
root spec environment ^[A-Z_][A-Z0-9_]*$
Type: string

root spec container_port
Type: integer

Port exposed by the container

Value must be greater or equal to 1 and lesser or equal to 65535

root spec protocol
Type: enum (of string) Default: "http"

Protocol used by the service (http or grpc)

Must be one of:

  • "http"
  • "grpc"

root spec scalability
Type: object
No Additional Properties

root spec scalability min_instances
Type: integer

Minimum number of pod instances

Value must be greater or equal to 0

root spec scalability max_instances
Type: integer

Maximum number of pod instances

Value must be greater or equal to 1

root spec scalability cpu_utilization
Type: integer

Target CPU utilization percentage for autoscaling

Value must be greater or equal to 1 and lesser or equal to 100

root spec scalability max_unavailable
Type: integer

Maximum number of pod instances that can be evicted at a time

Value must be greater or equal to 1

root spec observability
Type: object
No Additional Properties

root spec observability scrape_targets
Type: array of string

List of Prometheus scrape targets

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root spec observability scrape_targets scrape_targets items
Type: string

Prometheus scrape target in format host:port

Must match regular expression: ^[^:]+:[0-9]+$

root spec resources
Type: object

Resource requests and limits for the container

 No Additional Properties

root spec resources requests
Type: object
No Additional Properties

root spec resources requests cpu
Type: string

CPU resource quantity (e.g., '100m', '0.5', '2')

Must match regular expression: ^[0-9]+(\.[0-9]+)?$|^[0-9]+m$

root spec resources requests memory
Type: string

Memory resource quantity (e.g., '128Mi', '1Gi')

Must match regular expression: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki)?$

root spec resources requests ephemeral-storage
Type: string

Ephemeral storage resource quantity (e.g., '512Mi', '1Gi')

Must match regular expression: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki)?$

root spec startup_probe
Type: object

Startup probe configuration

 No Additional Properties

root spec startup_probe path
Type: string

HTTP path for the probe (must start with /)

Must match regular expression: ^/.*

root spec startup_probe timeout_seconds
Type: integer

Number of seconds after which the probe times out

Value must be greater or equal to 1

root spec startup_probe period_seconds
Type: integer

How often (in seconds) to perform the probe

Value must be greater or equal to 1

root spec startup_probe failure_threshold
Type: integer

Minimum consecutive failures for the probe to be considered failed

Value must be greater or equal to 1

root spec startup_probe success_threshold
Type: integer Default: 1

Minimum consecutive successes for the probe to be considered successful

Value must be greater or equal to 1

root spec startup_probe initial_delay_seconds
Type: integer

Number of seconds after container start before probe is initiated

Value must be greater or equal to 0

root spec liveness_probe
Type: object

Liveness probe configuration

root spec liveness_probe allOf probe
Type: object
Same definition as startup_probe
root spec liveness_probe allOf item 1
Type: object

root spec liveness_probe allOf item 1 success_threshold
Type: object Default: 2

root spec readiness_probe
Type: object

Readiness probe configuration

Same definition as startup_probe

root spec load_balancing
Type: object

Load balancing configuration (defaults to external if not specified)

 No Additional Properties

root spec load_balancing external_load_balancer
Type: object

External (public) load balancer configuration

 No Additional Properties

root spec load_balancing external_load_balancer enabled
Type: boolean

Enable the load balancer

root spec load_balancing internal_load_balancer
Type: object

Internal (private) load balancer configuration

Same definition as external_load_balancer

root spec load_balancing cloudflare
Type: object

Cloudflare configuration

 No Additional Properties

root spec load_balancing cloudflare enabled
Type: boolean Default: true

Create a Cloudflare zone with backend traffic restricted to Cloudflare IPs and Authenticated Origin Pulls enabled (default: true)

root spec configMapVolumes
Type: array of object

List of ConfigMap volumes to mount in the container

 No Additional Items

Each item of this array must be:

root spec configMapVolumes configMapVolumes items
Type: object
No Additional Properties

root spec configMapVolumes configMapVolumes items name
Type: string

Name of the ConfigMap

root spec configMapVolumes configMapVolumes items path
Type: string

Mount path for the ConfigMap volume (must start with /)

Must match regular expression: ^/.*

root deployment
Type: object

Deployment-specific configuration (not part of the service specification)

 No Additional Properties

root deployment ingress
Type: object

Ingress configuration options

 No Additional Properties

root deployment ingress enabled
Type: boolean

Enable Ingress resource creation. When enabled, tlsSecretName and at least one host must be provided.

root deployment ingress tlsSecretName
Type: string

Name of the Kubernetes secret containing the TLS certificate. Required when Ingress is enabled.

root deployment ingress class
Type: string

Name of the ingress class to use

root deployment ingress annotations
Type: object

Map of annotations for the ingress object

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-zA-Z0-9._/-]+$
root deployment ingress annotations ^[a-zA-Z0-9._/-]+$
Type: string

root deployment ingress pathPrefix
Type: string Default: "/"

Default path prefix for all hosts

root deployment ingress pathType
Type: enum (of string) Default: "Prefix"

Default path type for all hosts

Must be one of:

  • "Prefix"
  • "Exact"
  • "ImplementationSpecific"

root deployment ingress hosts
Type: array of object

List of hostnames for the ingress rules. Exactly one host is required when Ingress is enabled.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root deployment ingress hosts hosts items
Type: object

Host configuration with optional per-host path settings

 No Additional Properties

root deployment ingress hosts hosts items name
Type: stringFormat: hostname

The DNS hostname

root deployment ingress hosts hosts items pathPrefix
Type: string Default: "/"

Path prefix for this specific host (overrides default)

root deployment ingress hosts hosts items pathType
Type: enum (of string) Default: "Prefix"

Path type for this specific host (overrides default)

Must be one of:

  • "Prefix"
  • "Exact"
  • "ImplementationSpecific"

root deployment httpRoute
Type: object

HTTPRoute configuration for Gateway API

 No Additional Properties

root deployment httpRoute enabled
Type: boolean

Enable HTTPRoute resource creation

root deployment httpRoute gatewayName
Type: string

Name of the Gateway to attach to

root deployment httpRoute gatewayNamespace
Type: string

Namespace of the Gateway to attach to

root deployment httpRoute annotations
Type: object

Map of annotations for the HTTPRoute object

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-zA-Z0-9._/-]+$
root deployment httpRoute annotations ^[a-zA-Z0-9._/-]+$
Type: string