Service

Stable virtual address load balancing layer 4 traffic across the ready Pods a selector matches.

Provider: k8s
Kind: Load balancer
Category: Edge
Official docs: https://kubernetes.io/docs/concepts/services-networking/service/
Also known as: svc

Properties · 4 set by this component

property	type	values	required	kind default	this component
connectionPreserving · advanced	boolean	—	no	false	inherited
global	boolean	—	no	false	▸ false
hashing	enum	round-robin \| least-connections \| ecmp \| maglev \| consistent \| random	no	round-robin	▸ random
headless · component property	boolean	—	no	false	inherited
healthChecks	boolean	—	no	true	inherited
instances	integer	—	no	—	inherited
internalTrafficPolicy · component property	enum	cluster \| local	no	cluster	inherited
ipFamilyPolicy · component property	enum	single-stack \| prefer-dual-stack \| require-dual-stack	no	single-stack	inherited
layer	enum	l4 \| l7	no	l7	▸ l4
managed	boolean	—	no	false	▸ false
serviceType · component property	enum	cluster-ip \| node-port \| load-balancer \| external-name	no	cluster-ip	inherited
sessionAffinity · component property	enum	none \| client-ip	no	none	inherited

Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.

Use it in a design

nodes:
  - { id: "service", component: "k8s-service" }

Other Load balancer products · 34

Server Load Balanceralibaba-slbalibabacloudload-balancer AWS Application Load Balanceralbawsload-balancer AWS Classic Load Balanceraws-classic-load-balancerawsload-balancer AWS Global Acceleratoraws-global-acceleratorawsload-balancer AWS Gateway Load Balanceraws-gwlbawsload-balancer AWS Network Load Balancernlbawsload-balancer Azure Application Gatewayazure-application-gatewayazureload-balancer Application Gateway for Containersazure-application-gateway-for-containersazureload-balancer Azure Load Balancerazure-load-balancerazureload-balancer Cloudflare Load Balancingcloudflare-load-balancingcloudflareload-balancer Cloudflare Spectrumcloudflare-spectrumcloudflareload-balancer Apache HTTP Serverapache-httpdload-balancer BFEbfeload-balancer Caddycaddyload-balancer Contourcontourload-balancer Envoyenvoyload-balancer F5 BIG-IPf5-big-ipload-balancer HAProxyhaproxyload-balancer Keepalivedkeepalivedload-balancer Generic load balancerload-balancerload-balancer Load balancerload-balancer-tierload-balancer loxilbloxilbload-balancer MetalLBmetallbload-balancer NGINXnginxload-balancer Traefiktraefikload-balancer DigitalOcean Load Balancersdigitalocean-load-balancerdigitaloceanload-balancer Google Cloud Load Balancinggoogle-cloud-load-balancinggcpload-balancer IBM Cloud Load Balancer for VPCibm-load-balanceribmload-balancer Kubernetes Gatewayk8s-gatewayk8sload-balancer Ingressk8s-ingressk8sload-balancer OCI Load Balanceroci-load-balancerociload-balancer Network Load Balanceroci-network-load-balancerociload-balancer OpenStack Octaviaopenstack-octaviaopenstackload-balancer Load Balancer Unit (LBU)outscale-lbuoutscaleload-balancer

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Kubernetes Service: a stable virtual address in front of the Pods a label selector matches,
3# load balanced at OSI layer 3-4. Per "Service" the type defaults to ClusterIP (reachable only
4# inside the cluster), sessionAffinity defaults to None, internalTrafficPolicy to Cluster and
5# ipFamilyPolicy to SingleStack; kube-proxy in iptables mode picks a backend at random, and
6# traffic goes only to endpoints whose readiness condition is true.
7schemaVersion: "1"
8type: "component"
9id: "k8s-service"
10kind: "load-balancer"
11provider: "k8s"
12docs: "https://kubernetes.io/docs/concepts/services-networking/service/"
13aliases: ["svc"]
14defaults:
15  managed: false
16  layer: "l4"
17  hashing: "random"
18  global: false
19properties:
20  serviceType:
21    type: "enum"
22    values: ["cluster-ip", "node-port", "load-balancer", "external-name"]
23    default: "cluster-ip"
24  sessionAffinity:
25    type: "enum"
26    values: ["none", "client-ip"]
27    default: "none"
28  internalTrafficPolicy:
29    type: "enum"
30    values: ["cluster", "local"]
31    default: "cluster"
32  ipFamilyPolicy:
33    type: "enum"
34    values: ["single-stack", "prefer-dual-stack", "require-dual-stack"]
35    default: "single-stack"
36  headless:
37    type: "boolean"
38    default: false

The same page as markdown, for an agent: /catalogue/components/k8s-service.md