Custom Resource Definitions (CRDs)

This page describes the BIG-IP Next CIS in CRD Mode.

What are CRDs?

  • Custom resources are extensions of the Kubernetes API.
  • A resource is an endpoint in the Kubernetes API that stores a collection of API objects. For example, the built-in pods resource contains a collection of Pod objects.
  • A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation. It represents a customization of a particular Kubernetes installation. However, many core Kubernetes functions are now built using custom resources, making Kubernetes more modular.
  • Custom resources can appear and disappear in a running cluster through dynamic registration, and cluster admins can update custom resources independently of the cluster itself. Once a custom resource is installed, users can create and access its objects using kubectl, just as they do for built-in resources like Pods.
  • The BIG-IP Next CIS supports the following Custom Resources:

Transport Server

The TransportServer resource exposes the non-HTTP traffic configuration for a virtual server address in BIG-IP Next.

Parameters

PARAMETER TYPE REQUIRED DEFAULT DESCRIPTION
pool pool Required NA BIG-IP Next Pool member
virtualServerAddress String Optional NA
IPv4/IPv6 IP Address of BIG-IP Next Virtual Server. IP address
can also be replaced by a reference to a Service_Address.
ipamLabel String Optional NA
IPAM label name for IP address management which is map to
ip-range in IPAM controller deployment.
hostGroup String Optional NA To leverage the IP from VS CR using the same VS HostGroup name and Vice-versa.
policyName String Optional NA Name of Policy CRD to attach profiles/policies defined in it.
serviceAddress List of service address Optional NA
Service address definition allows you to add a number of
properties to your (virtual) server address
virtualServerPort String Required NA Port Address of BIG-IP Next Virtual Server
virtualServerName String Optional NA Custom name of BIG-IP Next Virtual Server
type String Optional tcp “tcp”, “udp” or “sctp” L4 transport server type
mode String Required NA “standard” or “performance”. A Standard mode transport server processes connections using the full proxy architecture. A Performance mode transport server uses FastL4 packet-by-packet TCP behavior.
snat String Optional auto  
host String Optional NA HostName of the Virtual Server
partition String Optional NA bigip partition

Pool Components

PARAMETER TYPE REQUIRED DEFAULT DESCRIPTION
service String Required NA Service deployed in kubernetes cluster
servicePort Integer or String Required NA Port to access Service.Could be service port, service port name or targetPort of the service
monitor monitor Optional NA Health Monitor to check the health of Pool Members
loadBalancingMethod String Optional round-robin Allowed values are existing BIG-IP Next Load Balancing methods for pools.
nodeMemberLabel String Optional NA List of Nodes to consider in NodePort Mode as BIG-IP Next pool members. This Option is only applicable for NodePort Mode
serviceNamespace String Optional NA
Namespace of service, define it if service is present in a
namespace other than the one where transport Server Custom Resource is present

Health Monitor

PARAMETER TYPE REQUIRED DEFAULT DESCRIPTION
type String Required NA tcp, icmp
interval Int Required 5 Seconds between health queries
timeout Int Optional 16 Seconds before query fails

See examples Here


Note

To provide feedback on Container Ingress Services or this documentation, please file a GitHub Issue.