From 6a9207d03c3514c9828cae6933c163c29a5fc136 Mon Sep 17 00:00:00 2001
From: TrekkieCoder <111065900+TrekkieCoder@users.noreply.github.com>
Date: Thu, 18 Apr 2024 15:35:47 +0900
Subject: [PATCH] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 2e49f3b..03fcd97 100644
--- a/README.md
+++ b/README.md
@@ -79,7 +79,7 @@ Many of the above flags and arguments can be overriden on a per-service basis ba
| loxilb.io/secondaryIPs | When using the SCTP multi-homing function, specify the secondary IP to be assigned to the service. Multiple IPs(upto 3) can be specified at the same time using a comma(,). When used with the loxilb.io/num-secondary-networks annotation, loxilb.io/secondaryIPs takes priority.)
Example:
metadata:
name: sctp-lb-secips
annotations:
loxilb.io/lbmode: "fullnat"
loxilb.io/secondaryIPs: "1.1.1.1,2.2.2.2"
spec:
loadBalancerClass: loxilb.io/loxilb
selector:
what: sctp-lb-secips
ports:
- port: 56004
targetPort: 9999
protocol: SCTP
type: LoadBalancer|
| loxilb.io/staticIP | Specifies the External IP to assign to the LoadBalancer service. By default, an external IP is assigned within the externalCIDR range set in kube-loxilb, but using the annotation, IPs outside the range can also be statically specified.
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb-fullnat
annotations:
loxilb.io/lbmode: "fullnat"
loxilb.io/staticIP: "192.168.255.254"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-fullnat-test
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer|
| loxilb.io/liveness | Set LoxiLB to perform a health check (probe) based endpoint selection(If flag is set, only active endpoints will be selected). The default value is no, and when the value is set to yes, the probe function of the corresponding service is activated.
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb-fullnat
annotations:
loxilb.io/liveness : "yes"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-fullnat-test
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer|
-| loxilb.io/lbmode | Set LB mode individually for each service. There are three types of values that can be specified: “default”, “onearm”, and “fullnat”. Please refer to [this](https://loxilb-io.github.io/loxilbdocs/nat/) document for more details.
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb-fullnat
annotations:
loxilb.io/lbmode: "fullnat"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-fullnat-test
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer |
+| loxilb.io/lbmode | Set LB mode individually for each service. The values that can be specified: “default”, “onearm”, “fullnat” and "dsr". Please refer to [this](https://loxilb-io.github.io/loxilbdocs/nat/) document for more details.
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb-fullnat
annotations:
loxilb.io/lbmode: "fullnat"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-fullnat-test
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer |
| loxilb.io/ipam | Specify which IPAM mode the service will use. Select one of three options: “ipv4”, “ipv6”, or “ipv6to4”.
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb
annotations:
loxilb.io/ipam : "ipv4"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-lb
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer |
| loxilb.io/timeout | Set the session retention time for the service.
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb
annotations:
loxilb.io/timeout : "60"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-lb
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer |
| loxilb.io/probetype | Specifies the protocol type to use for endpoint probe operations. You can select one of “udp”, “tcp”, “https”, “http”, “sctp”, “ping”, or “none”. Probetype is set to protocol type, if you are using lbMode as "fullnat" or "onearm". To set it off, use probetype : "none"
Example:
apiVersion: v1
kind: Service
metadata:
name: sctp-lb
annotations:
loxilb.io/probetype : "ping"
spec:
loadBalancerClass: loxilb.io/loxilb
externalTrafficPolicy: Local
selector:
what: sctp-lb
ports:
- port: 56004
protocol: SCTP
targetPort: 9999
type: LoadBalancer |