SPK Software¶
Overview¶
The Service Proxy for Kubernetes (SPK) custom resource definitions (CRDs), software images and installation Helm charts are provided in a single TAR file. An SPK public signing key, and two signature files are also provided to validate the TAR file’s integrity. Once validated and extracted, the software images can be uploaded to a local container registry, and integrated into the cluster using the SPK Helm charts. Finally, the SPK CRDs will be installed into the cluster.
This document describes the SPK software, and guides you through validating, extracting and installing the SPK software components.
Software images¶
The table below lists and describes the software images for this software release. For a full list of software images by release, refer to the Software Releases guide.
Note: The software image name and deployed container name may differ.
| Image | Version | Description |
|---|---|---|
| f5ingress | v0.761.1-0.1.4 | The helm_release-f5ingress container is the custom SPK controller that watches the K8S API for CR updates, and configures the Service Proxy TMM based on the update. |
| tmm-img | v10.14.2-0.2.4 | The f5-tmm container is a Traffic Management Microkernel (TMM) that proxies and load balances application traffic between the external and internal networks. |
| spk-cwc | v0.34.14-10.0.13 | The spk-cwc container enables software licensing, and reports telemetry statistics regarding monthly SPK software CRD usage summaries. Refer to SPK CWC. |
| f5-license-helper | v0.12.5-0.0.8 | The f5-lic-helper communicates with the spk-cwc to determine the current license status of the cluster. |
| rabbit | v0.5.9-0.0.6 | The rabbitmq-server container as a general message bus, integrating SPK CWC with the Controller Pod(s) for licensing purposes. |
| crd-conversion | v1.62.8-0.0.4 | The f5-crd-conversion container handles the automatic conversion of multiple CRD versions based on the specified namespace and version in the cluser, without affecting existing CRs. Refer to CRD Conversion Webhook. |
| tmrouted-img | v2.1.7-0.1.4 | The f5-tmm-tmrouted container proxies and forwards information between the f5-tmm-routing and f5-tmm containers. |
| f5dr-img | v3.2.1-0.0.9 | The f5-tmm-routing container maintains the dynamic routing tables used by TMM. Refer to BGP Overview. |
| f5-cert-client | v3.0.17-0.0.8 | The f5-cert-client container provides an interface for SPK components to request certificates from f5-cert-manager. Additionally, f5-cert-client can provide certificate rotation functionality for those SPK components. |
| f5-toda-tmstatsd | v1.11.12-10.0.3 | The f5-toda-stats container collects application traffic processing statistics from the f5-tmm container, and forwards the data to the f5-fluentbit container. |
| f5-toda-observer | v4.56.4-0.0.19 | The f5-toda-observer container image is used for three pods: f5-observer-receiver, f5-observer, and f5-observer-operator. These pods work together to efficiently manage the high volume of statistics by collecting, aggregating, and exporting them to the OTEL Collector pod. |
| cert-manager-controller | v2.3.0 | The cert-manager-controller manages the generation and rotation of the SSL/TLS certificate that are stored as Secrets, to secure communication between the various CNFs Pods. |
| cert-manager-cainjector | v2.3.0 | The cert-manager-cainjector assists the cert-manager-controller to configure the CA certificates used by the cert-manager-webhook and K8S API. |
| cert-manager-webhook | v2.3.0 | The cert-manager-webhook ensures that SSL/TLS certificate resources created or updated by the cert-manager-contoller conform to the API specifications. |
| f5-fluentbit | v1.0.5-0.0.5 | The fluentbit container collects and forwards statistics to the f5-fluentd container. Multiple versions are included to support the different SPK containers. |
| f5-fluentd | v2.0.6-10.0.5 | The f5-fluentd container collects statistics and logging data from the Controller, TMM and dSSM Pods. Refer to Fluentd Logging. |
| f5-dssm-store | v5.0.7-10.0.4 | Contains two sets of software images; The f5-dssm-db containers that store shared, persisted session state data, and the f5-dssm-sentinel containers to monitor the f5-dssm-db containers. Refer to dSSM database. |
| f5-debug-sidecar | v8.57.0-0.3.4 | The debug container provides diagnostic tools for viewing TMM's configuration, traffic processing statistica and gathering TMM diagnostic data. Refer to Debug Sidecar. |
| opentelemetry-collector-contrib | 0.126.0 | The otel-collector container gathers metrics and statistics from the TMM Pods. Refer to OTEL Collector. |
| f5-dssm-upgrader | v2.0.9-10.0.6 | The dssm-upgrade-hook enables dSSM DBs upgrades without service interruption or data loss. Refer to Upgrading dSSM. |
| f5-l4p-engine | v1.120.3-10.0.4 | The f5-afm-pccd container is an Application Firewall Manager (AFM) instance that converts firewall rules and NAT policies into the binary large objects (BLOBs) used by TMM. |
| f5-blobd | v1.10.0-10.0.7 | The f5-blobd container allows loading binary large objects (BLOBs) into the TMM memory. It is required for AFM use-cases, like firewall and NAT. |
| spk-csrc | v0.5.11-0.0.5 | The spk-csrc containers (daemon-set) used to support the Calico Egress GW feature. |
| f5-csm-qkview | v0.10.23-0.0.4 | The f5-csm-qkview includes the qkview-orchestrator service, which manages requests from CWC to create or download qkview tar files. It communicates with qkview-collect, initiating the process of generating and downloading qkview tar files from containers within a designated namespace. |
CRD Bundles¶
The tables below list the SPK CRD bundles, and describe the SPK CRs they support.
f5-spk-crds-service-proxy-8.5.2-0.1.12.tgz
| CRD | CR |
|---|---|
| f5-spk-egress | F5SPKEgress - Enable egress traffic for Pods using SNAT or DNS/NAT46. |
| f5-spk-ingresstcp | F5SPKIngressTCP - Layer 4 TCP application traffic management. |
| f5-spk-ingressudp | F5SPKIngressUDP - Layer 4 UDP application traffic management. |
| f5-spk-ingressgtp | F5SPKIngressGTP - GTP traffic management. |
| f5-spk-ingressngap | F5SPKIngressNGAP - Datagram load balancing for SCTP or NGAP signaling. |
| f5-spk-ingresssip | F5SPKIngressSip - Ingress SIP application traffic management. |
| f5-spk-ingressHTTP2 | F5SPKIngressHTTP2 - HTTP/2 application traffic management. |
| f5-spk-ingressdiameter | F5SPKIngressDiameter - Diameter traffic management using TCP or SCTP. |
| f5-spk-ingressegressudp | F5SPKIngressEgressUDP - Ingress UDP traffic management, enabling VIP source address responses. |
f5-spk-crds-common.8.5.2-0.1.12.tgz
| CRD | CR |
|---|---|
| f5-spk-vlan | F5SPKVlan - TMM interface configuration: VLANs, Self IP addresses, MTU sizes, etc. |
| f5-spk-dnscache | F5SPKDnscache - Referenced by the F5SPKEgress CR to provide DNS caching. |
| f5-spk-snatpool | F5SPKSnatpool - Allocates IP addresses for egress Pod connections. |
| f5-spk-staticroute | F5SPKStaticRoute - Provides TMM static routing table management. |
| f5-spk-addresslist | Not currently in use. |
| f5-spk-portlist | Not currently in use. |
f5-spk-crds-deprecated.8.5.2-0.1.12.tgz
A bundle containing the deprecated CRDs, beginning with SPK software version 1.4.3.
Requirements¶
Ensure you have:
Procedures¶
Extract the images¶
Use the following steps to validate the CNE tarball, and extract the software images, installation Helm charts, and CRDs.
Note: F5 now provides a single tarball for SPK and CNF. As a result, you may notice the SPK CRDs bundles included in the tarball and manifest file. F5 recommends that you avoid downloading the SPK CRDs bundle, as it may conflict with the CNF CRDs. The software image name and deployed container name may differ.
Create a new directory for the files:
mkdir <directory>In this example, the new directory is named spkinstall:
mkdir spkinstallMove the files into the directory:
mv f5-cne* F5-CNE-2.0.2-3.233.0+0.3.173.pem spkinstall
Change into the directory and list the files:
cd spkinstall; ls -1
The file list appears as:
F5-CNE-2.0.2-3.233.0+0.3.173.pem F5-CNE-2.0.2-3.233.0+0.3.173.tgz F5-CNE-sha512.txt-2.0.2-3.233.0+0.3.173.sha512.sig F5-CNE.tgz-2.0.2-3.233.0+0.3.173.sha512.sig
Use the PEM signing key and each SHA signature file to validate the TAR file:
openssl dgst -verify <pem file>.pem -keyform PEM \ -sha512 -signature <sig file>.sig <tar file>.tgz
The command output states Verified OK for each signature file:
openssl dgst -verify F5-CNE-2.0.2-3.233.0+0.3.173.pem -keyform PEM -sha512 \ -signature F5-CNE.tgz-2.0.2-3.233.0+0.3.173.sha512.sig \ F5-CNE-2.0.2-3.233.0+0.3.173.tgz
Verified OKopenssl dgst -verify F5-CNE-2.0.2-3.233.0+0.3.173.pem -keyform PEM -sha512 \ -signature F5-CNE-sha512.txt-2.0.2-3.233.0+0.3.173.sha512.sig \ F5-CNE-2.0.2-3.233.0+0.3.173.tgz
Verified OKExtract the CRD bundles and the software image TAR file:
tar xvf F5-CNE-2.0.2-3.233.0+0.3.173.tgz
List the newly extracted files:
ls -1The file list shows the CRD bundles and the image TAR file named f5-cne-images-2.0.2-3.233.0+0.3.173.tgz:
F5-CNE-2.0.2-3.233.0+0.3.173.pem f5-cnf-crds-n6lan-8.5.2-0.1.12.tgz f5-spk-crds-common-8.5.2-0.1.12.tgz f5-spk-crds-deprecated-8.5.2-0.1.12.tgz f5-spk-crds-service-proxy-8.5.2-0.1.12.tgz f5-cne-images-2.0.2-3.233.0+0.3.173.tgz F5-CNE-2.0.2-3.233.0+0.3.173.tgz F5-CNE-sha512.txt-2.0.2-3.233.0+0.3.173.sha512.sig F5-CNE.tgz-2.0.2-3.233.0+0.3.173.sha512.sig
Extract the software images and Helm charts:
tar xvf f5-cne-images-2.0.2-3.233.0+0.3.173.tgz
Recursively list the extracted software images and Helm charts:
ls -1RThe file list shows a new tar directory containing the software images and Helm charts:
F5-CNE-2.0.2-3.233.0+0.3.173. f5-cnf-crds-n6lan-8.5.2-0.1.12.tgz f5-spk-crds-common-8.5.2-0.1.12.tgz f5-spk-crds-deprecated-8.5.2-0.1.12.tgz f5-spk-crds-service-proxy-8.5.2-0.1.12.tgz f5-cne-images-2.0.2-3.233.0+0.3.173.tgz F5-CNE-2.0.2-3.233.0+0.3.173.tgz F5-CNE-sha512.txt-2.0.2-3.233.0+0.3.173.sha512.sig F5-CNE.tgz-2.0.2-3.233.0+0.3.173.sha512.sig tar ./tar: csrc-0.7.3-0.0.9.tgz cwc-0.41.34-10.0.30.tgz coremond-0.7.27-10.0.16.tgz dnat-util-v0.5.4.tgz f5-cert-gen-0.9.3.tgz f5-cert-manager-0.23.28-0.0.14.tgz f5-crdconversion-0.16.15-0.0.19.tgz f5-dssm-1.0.15-0.1.11.tgz f5-toda-fluentd-1.31.12-10.0.16.tgz f5ingress-v0.761.1-0.1.4.tgz log-doc-f5ingress-0.761.1+0.1.4.tgz rabbitmq-0.5.10-10.0.24.tgz f5-toda-observer-v4.56.4-0.0.19.tgz cne-docker-images.tgz
Continue to the next section.
Install the CRDs¶
Use the following steps to extract and install the new SPK CRDs.
List the SPK CRD bundles:
ls -1 | grep crd
The file list shows three CRD bundles:
f5-spk-crds-common-8.5.2-0.1.12.tgz f5-spk-crds-deprecated-8.5.2-0.1.12.tgz f5-spk-crds-service-proxy-8.5.2-0.1.12.tgz
Install the full set of common CRDs using Helm install:
helm install crd-common tar/f5-spk-crds-common-8.5.2-0.1.12.tgz -f crd-values.yaml
Example: crd-values.yaml file (We only need to use this namespace parameter when CRD Conversion is deployed in a non-default namespace. The value of the namespace parameter should match the namespace in which CRD Conversion is deployed.)
conversion: namespace: spk-crdconversion
Note the command output: Newly installed CRDs will be indicated by created, and updated CRDs will be indicated by configured:
f5-spk-addresslists.k8s.f5net.com configured f5-spk-dnscaches.k8s.f5net.com created f5-spk-portlists.k8s.f5net.com configured f5-spk-snatpools.k8s.f5net.com unchanged f5-spk-staticroutes.k8s.f5net.com unchanged f5-spk-vlans.k8s.f5net.com configured
Install the full set of service-proxy CRDs using Helm install:
helm install crd-proxy tar/f5-spk-crds-service-proxy-8.5.2-0.1.12.tgz -f crd-values.yaml
Example: crd-values.yaml file (We only need to use this namespace parameter when CRD Conversion is deployed in a non-default namespace. The value of the namespace parameter should match the namespace in which CRD Conversion is deployed.)
conversion: namespace: spk-crdconversion
Note the command output: Newly installed CRDs will be indicated by created, and updated CRDs will be indicated by configured:
f5-spk-egresses.k8s.f5net.com configured f5-spk-ingressdiameters.k8s.f5net.com unchanged f5-spk-ingressngaps.k8s.f5net.com unchanged f5-spk-ingresstcps.ingresstcp.k8s.f5net.com unchanged f5-spk-ingressudps.ingressudp.k8s.f5net.com unchanged
List the installed SPK CRDs:
oc get crds | grep f5-spk
The CRD listing will contain the full list of CRDs:
f5-spk-addresslists.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-dnscaches.k8s.f5net.com 2021-12-23T18:41:54Z f5-spk-egresses.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-ingressdiameters.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-ingressgtps.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-ingresshttp2s.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-ingressngaps.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-ingresstcps.ingresstcp.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-ingressudps.ingressudp.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-portlists.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-snatpools.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-staticroutes.k8s.f5net.com 2021-12-23T18:38:45Z f5-spk-vlans.k8s.f5net.com 2021-12-23T18:38:45Z
Upload the images¶
Use the following steps to upload the SPK software images to a local container registry.
Install the SPK images to your workstation’s Docker image store:
podman load -i tar/cne-docker-images.tgz
List the SPK images to be tagged and pushed to the local container registry in the next step:
podman images --format "table {{.Repository}} {{.Tag}} {{.ID}}"
REPOSITORY TAG IMAGE ID local.registry/f5ingress v0.761.1-0.1.4 ec53ca6224d5 local.registry/f5-license-helper v0.12.5-0.0.8 efb39354f88c local.registry/spk-cwc v0.34.14-10.0.13 d00a312c0c0f local.registry/rabbit v0.5.9-0.0.6 74a99a71373e local.registry/tmm-img v10.14.2-0.2.4 084cf6009192 local.registry/spk-csrc v0.5.11-0.0.5 8239a89070d2 local.registry/f5-debug-sidecar v8.57.0-0.3.4 c2aeeeb7f9d8 local.registry/f5dr-img-init v3.2.1-0.0.9 4447f2306545 local.registry/f5-cert-client v3.0.17-0.0.8 489962b4f004 local.registry/f5dr-img v3.2.1-0.0.9 16cb6c9dae1d local.registry/tmrouted-img v2.1.7-0.1.4 f843080ef62e local.registry/f5-toda-observer v4.56.4-0.0.19 779f37d12231 local.registry/f5-fluentd v2.0.6-10.0.5 db2090620fd5 local.registry/crd-conversion v1.62.8-0.0.4 5a7d5db132e6 local.registry/cert-manager-ctl 2.2.3 48f768b562b4 local.registry/cert-manager-webhook v2.3.0 4eb33f2045a9 local.registry/cert-manager-cainjector v2.3.0 f1fd7c702b40 local.registry/cert-manager-controller v2.3.0 da7a341236d4 local.registry/init-certmgr v0.23.28-0.0.14 80ec7c1f1729 local.registry/f5-toda-tmstatsd v1.11.12-10.0.3 0815da811e29 local.registry/f5-dssm-upgrader v2.0.9-10.0.6 2f256b90af97 local.registry/f5-dssm-store v5.0.7-10.0.4 d19ecefbdfbf local.registry/f5-l4p-engine v1.120.3-10.0.4 a4a78a92c365 local.registry/opentelemetry-collector-contrib 0.126.0 70d58b50c03b local.registry/f5-fluentbit v1.0.5-0.0.5 ac1eb788d4f9 local.registry/f5-blobd v1.10.0-10.0.7 66741f0bc3d0 local.registry/f5-csm-qkview v0.10.23-0.0.4 a2d5402771b1 local.registry/f5-bdosd v0.35.0-0.0.7 7b1b2407a0d2 local.registry/f5-version-validator v1.0.5-10.0.10 5765e83b6962 local.registry/f5-dwbld v1.33.0-0.1.1 41194b4bb106 local.registry/f5ing-tmm-pod-manager v1.0.8-0.1.9 b5e9fb8f6f48 local.registry/f5-coremond v0.7.27-10.0.16 db393687748c local.registry/dnsx-img v0.10.11-0.0.7 d9ba1b9fef3e local.registry/f5-nsec-ips-daemon v3.4.8-0.0.9 4de0673d392e local.registry/cert-manager-startupapicheck v2.3.0 b3bed6de8ba9 local.registry/crdupdater v0.4.26-0.0.5 d46beaff48e5 local.registry/f5-downloader v0.8.1-0.0.12 2591431ceb9e
Tag and push each image to the local container registry. For example:
podman tag <local.registry/image name>:<version> <registry>/<image name>:<version>
podman push <registry_name>/<image name>:<version>
In this example, the f5ingress:v0.761.1-0.1.4 image is tagged and pushed to the remote registry registry.com:
podman tag local.registry/f5ingress:v0.761.1-0.1.4 registry.com/f5ingress:v0.761.1-0.1.4
podman push registry.com/f5ingress:v0.761.1-0.1.4
Once all of the images have uploaded, verify the images exist in the local container registry:
curl -X GET https://<registry>/v2/_catalog -u <user:pass>
For example:
curl -X GET https://registry.com/v2/_catalog -u spkadmin:spkadmin
"repositories":["f5-debug-sidecar","f5-dssm-store","f5-fluentbit","f5-fluentd","f5-toda-tmstatsd","f5dr-img","f5ingress","tmm-img","tmrouted-img"]}
Next step
Continue to the SPK Cert Manager guide to secure SPK communications.
Supplemental
Feedback
Provide feedback to improve this document by emailing spkdocs@f5.com.