F5PersistenceProfile¶
Overview¶
The F5PersistenceProfile CR is applied on the DAG layer secure context to distribute the traffic across the TMM pods of the CNF layer with persistence properties. This CR provides options for source address based and destination address based persistence.
The persistence is determined using either CARP or default algorithm.
CR Parameters¶
The tables in this section list and describes the F5PersistenceProfile CR parameters.
metadata¶
| Parameter | Description |
|---|---|
| name | The name of the Persistence Profile CR. |
spec¶
| Parameter | Description |
|---|---|
| persistenceType | Specifies the persistence type or address affinity. Source address type directs session requests to the same server, based only on the source IP address of a packet. Whereas, Destination address type does the same based only on the destination IP address of a packet. The default type is Source address (SRC_ADDR) persistence. |
| timeout | Specifies the duration of the persistence entries in seconds. This applies only to DEFAULT hash algorithms. The default is 180 seconds. |
| addressAffinity | Specifies the configuration parameters corresponding to the persistence address affinity selected. The default is hashAlgorithm: CARP |
| addressAffinity.ipv4PrefixLength | Specifies the prefix length the user wants to use as the mask. The length must be the number of set bits in a bitmask between 1 and 32 for IPv4. The default is 32. |
| addressAffinity.ipv6PrefixLength | Specifies the prefix length that you want to use as the mask. The length must be the number of set bits in a bitmask between 1 and 128 for IPv6. The default is 128. |
| addressAffinity.hashAlgorithm | Specifies the hash algorithm for a given persistence type. CARP hash uses a stateless mechanism, which is independent of timeouts, to direct sessions to a specific server. This means the selection of a server from a pool of servers stays the same even if the number of servers in the pool are reduced. The DEFAULT hash generates and maintains persistent session records and the selection of a server could change based on factors such as, when a persistence record expires. The default hash algorithm is CARP. |
CR Example¶
apiVersion: "k8s.f5net.com/v1"
kind: F5BigPersistenceProfile
metadata:
name: source-address-persistence-profile
spec:
persistenceType: "SRC_ADDR"
addressAffinity:
ipv4PrefixLength: 24
hashAlgorithm: "CARP"
Requirements¶
Ensure the following requirements are met before starting with the DAG CNFs:
- Separate namespaces created in the Kubernetes cluster. CNF layer for the CNF product installation and DAG layer for the DAG installation. For example, the namespace created for DAG layer is dag-cnf and the namespace created for CNF layer is cnf.
- Install the F5ingress and TMM pods in both the namespaces.
- Install the Cluster Wide Components (CWC, dSSM, cert-manager, rabbitMQ, and so on) in any of the namespaces.
- A linux-based workstation.
Feedback
To provide feedback and help improve this document, please email us at cnfdocs@f5.com.