5697c5212b
Squashed commit: [a2bbe555] Update docs for services and groups [f04d91cf] don't require loadbalancer ip settings [188d40c0] fix typo [50735ac0] fix description on persistent storage, fix port names on websockets [42303b07] Refactor services part4 [9486e401] Refactor services part3 [2a0eb1a7] default ClusterIP on websocket (zwave) [43a1ca1b] Refactor services part2 [a80ee6b3] Refactor services part1 [b561be7e] Remove securityContext and podSecurityContext from apps with PGID/PUID [0ad14db2] move UMASK, PGID. PUID to env [3ab8bc1d] Rename environmentVariables to envList and environmentVariable to envItem [58b533af] Move securityContext to Security group [8baefb23] Move podSecurityContext to Security group [dcbf92ae] Rename reverse proxy to ingress [4a72f6c2] Remove ingress for now [9c3dac85] Refactor groups
198 lines
7.9 KiB
Markdown
198 lines
7.9 KiB
Markdown
# Services
|
|
|
|
Every App needs to be exposed to something, either an UI, API or other containers.However with Kubernetes we don't directly connect to the containers running the App, because those might be on another node or there might be multiple "high available" containers for the App. Instead we use what is called `Services`. Services are simply put "Internal Load-Balancers", they also guaranteed to be reachable by (internal!) DNS name and (in some cases) prevent traffic from reaching your App when the healthcheck isn't finished yet (or is failing).
|
|
|
|
### Two kinds of services
|
|
|
|
##### First: hostNetwork
|
|
|
|
Always add the hostNetwork option above the "services" section.
|
|
This is to try and keep things clear for the user.
|
|
|
|
```
|
|
# Enable Host Networking
|
|
- variable: hostNetwork
|
|
group: "Networking"
|
|
label: "Enable Host Networking"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
```
|
|
|
|
##### Main Service
|
|
|
|
Every App is required to have a main service, the primary thing that users (or other Apps!) connect with. No mater if it's a webUI, an API, a database connection or something totally else, A service is always required.
|
|
|
|
Please keep in mind that every App is different, some just have one service (which *ALWAYS* has to be called `main`) and others need more (which each has to have an unique name). Every App also uses different ports, so please alter accordingly.
|
|
|
|
```
|
|
- variable: service
|
|
group: "Networking"
|
|
label: "Configure Service(s)"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: main
|
|
label: "Main Service"
|
|
description: "The Primary service on which the healthcheck runs, often the webUI"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enable the service"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: type
|
|
label: "Service Type"
|
|
description: "ClusterIP's are only internally available, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer"
|
|
schema:
|
|
type: string
|
|
default: "NodePort"
|
|
enum:
|
|
- value: "NodePort"
|
|
description: "NodePort"
|
|
- value: "ClusterIP"
|
|
description: "ClusterIP"
|
|
- value: "LoadBalancer"
|
|
description: "LoadBalancer"
|
|
- variable: loadBalancerIP
|
|
label: "LoadBalancer IP"
|
|
description: "LoadBalancerIP"
|
|
schema:
|
|
show_if: [["type", "=", "LoadBalancer"]]
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: exetrnalIPs
|
|
label: "External IP's"
|
|
description: "External IP's"
|
|
schema:
|
|
show_if: [["type", "=", "LoadBalancer"]]
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: externalIP
|
|
label: "External IP"
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- variable: ports
|
|
label: "Service's Port(s) Configuration"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: main
|
|
label: "Main Service Port Configuration"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: protocol
|
|
label: "Port Type"
|
|
schema:
|
|
type: string
|
|
default: "HTTP"
|
|
hidden: false
|
|
enum:
|
|
- value: HTTP
|
|
description: "HTTP"
|
|
- value: "HTTPS"
|
|
description: "HTTPS"
|
|
- value: TCP
|
|
description: "TCP"
|
|
- value: "UDP"
|
|
description: "UDP"
|
|
- variable: port
|
|
label: "Container Port"
|
|
schema:
|
|
type: int
|
|
default: 5076
|
|
editable: false
|
|
hidden: true
|
|
- variable: targetport
|
|
label: "Target Port"
|
|
description: "This port exposes the container port on the service"
|
|
schema:
|
|
type: int
|
|
default: 5076
|
|
editable: true
|
|
hidden: false
|
|
required: true
|
|
- variable: nodePort
|
|
label: "Node Port (Optional)"
|
|
description: "This port gets exposed to the node. Only considered when service type is NodePort"
|
|
schema:
|
|
type: int
|
|
min: 9000
|
|
max: 65535
|
|
default: 36041
|
|
required: true
|
|
```
|
|
|
|
##### Unlimited custom services
|
|
|
|
in some edgecases users might need or want to have the option to add unlimited custom Services. While we _highly_ suggest not doing so, these services can be added with the following standardised template:
|
|
|
|
```
|
|
- variable: additionalServices
|
|
label: "Custom Services"
|
|
group: "Networking"
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: additionalService
|
|
label: "Custom Service"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enable the service"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: type
|
|
label: "Service type"
|
|
description: "ClusterIP's are only internally available, nodePorts expose the container to the host node System"
|
|
schema:
|
|
type: string
|
|
default: "ClusterIP"
|
|
enum:
|
|
- value: "nodePort"
|
|
description: "NodePort"
|
|
- value: "ClusterIP"
|
|
description: "ClusterIP"
|
|
- variable: port
|
|
label: "Port configuration"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: "container port"
|
|
schema:
|
|
type: int
|
|
default: 80
|
|
editable: false
|
|
hidden: true
|
|
- variable: targetport
|
|
label: "Internal Service port"
|
|
description: "When connecting internally to this App, you'll need this port"
|
|
schema:
|
|
type: int
|
|
default: 80
|
|
editable: false
|
|
hidden: true
|
|
- variable: nodePort
|
|
label: "(optional) host nodePort to expose to"
|
|
description: "only get used when nodePort is selected"
|
|
schema:
|
|
type: int
|
|
min: 9000
|
|
max: 65535
|
|
default: 36052
|
|
required: true
|
|
|
|
```
|