CNFs Software¶
Overview¶
The Cloud-Native Network Functions (CNFs) custom resource definitions (CRDs), software images and installation Helm charts are provided in a single TAR file. A CNFs 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 CNFs Helm charts. Finally, the CNFs CRDs will be installed into the cluster.
This document describes the CNFs software, and guides you through validating, extracting and installing the CNF 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.434.1-0.0.92 | The helm_release-f5ingress container is a custom CNF controller that watches the K8S API for CR updates, and configures either AFM or TMM based on the update. |
tmm-img | v0.893.0-0.0.21 | The f5-tmm container is a Traffic Management Microkernel (TMM) instance that proxies and load balances application traffic between the external and internal networks. |
f5-l4p-engine | v1.100.27 | 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-nsec-ips-daemon | v1.7.6-0.0.4 | The f5-ipsd container is the intrusion detection and prevention instance, providing deep packet inspection and prevention of malignant network packets. |
tmrouted-img | v0.12.0 | The f5-tmm-tmrouted container proxies and forwards information between the f5-tmm-routing and f5-tmm containers. |
f5dr-img | v0.10.9 | The f5-tmm-routing container maintains the dynamic routing tables used by TMM. |
f5-toda-tmstatsd | v1.9.9-0.0.1 | The f5-toda-stats container collects application traffic processing statistics from the f5-tmm container, and forwards the data to the Otel Collectors. |
f5-dssm-store | v1.25.18 | 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. For more info, refer to dSSM database. |
spk-cwc | v0.30.3-0.0.8 | The cnf-cwc container enables software licensing, and reports telemetry statistics regarding monthly software usage. Refer to CNFs CWC. |
f5-license-helper | v0.10.0-0.0.2 | The f5-lic-helper communicates with the spk-cwc to determine the current license status of the cluster. |
rabbit | v0.4.1 | The rabbitmq-server container as a general message bus, integrating CNFs CWC with the BIG-IP Controller Pod(s) for licensing purposes. |
cert-manager-controller | 2.2.3 | 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 | 2.2.3 | 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 | 2.2.3 | The cert-manager-webhook ensures that SSL/TLS certificate resources created or updated by the cert-manager-contoller conform to the API specifications. |
f5-debug-sidecar | v7.217.1 | The debug container provides diagnostic tools for viewing TMM's configuration, traffic processing statistics and gathering TMM diagnostic data. For more info, refer to Debug Sidecar. |
f5-fluentbit | v0.8.1-0.0.4 | The fluentbit container collects and forwards statistics to the f5-fluentd container. Multiple versions are included to support the different CNFs containers. |
f5-fluentd | v1.5.6 | The f5-fluentd container collects statistics and logging data from the Controller, TMM and dSSM Pods. For more info, refer to Fluentd Logging. |
opentelemetry-collector | 0.75.0 | The otel-collector container gathers metrics and statistics from the TMM Pods. Refer to OTEL Collector. |
f5-dssm-upgrader | 1.2.4 | The dssm-upgrade-hook enables dSSM DBs upgrades without service interruption or data loss. Refer to Upgrading dSSM. |
f5-csm-qkview | v26.18.1 | 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. |
f5-cert-client | v2.3.4 | 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. |
crd-conversion | v1.31.3-0.0.1 | 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. |
Requirements¶
Ensure you have:
- Obtained the CNF software tarball.
- A local container registry.
- A workstation with Podman.
Procedures¶
Validate and extract¶
Use the following steps to validate the CNFs tarball, extract the software images, installation Helm charts, and CRDs.
Create a new directory for the CNFs files:
mkdir <directory>
In this example, the new directory is named cnfinstall:
mkdir cnfinstall
Move the CNFs files into the directory:
mv f5-cnf-tarball* f5-cnf-1.2.0.pem cnfinstall
Change into the directory and list the files:
cd cnfinstall; ls -1
The files appear as:
f5-cnf-1.2.0.pem f5-cnf-tarball-1.2.0.tgz f5-cnf-tarball-sha512.txt-1.2.0.sha512.sig f5-cnf-tarball.tgz-1.2.0.sha512.sig
Use the PEM signing key and each SHA signature file to validate the CNFs 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-cnf-1.2.0.pem -keyform PEM -sha512 \ -signature f5-cnf-tarball.tgz-1.2.0.sha512.sig f5-cnf-tarball-1.2.0.tgz
Verified OK
openssl dgst -verify f5-cnf-1.2.0.pem -keyform PEM -sha512 \ -signature f5-cnf-tarball-sha512.txt-1.2.0.sha512.sig f5-cnf-tarball-1.2.0.tgz
Verified OK
Extract the CNFs images, Helm charts, and CRDs from the TAR file:
tar xvf f5-cnf-tarball-1.2.0.tgz
List the newly extracted files:
ls -1
The file list shows the CRD bundless and the CNF image TAR file named f5-cnf-images-1.2.0.tgz:
f5-cnf-crds-n6lan-0.145.3-0.0.12.tgz f5-cnf-images-1.2.0.tgz f5-cnf-tarball-1.2.0.tgz
Extract the CNF Helm charts and software images:
tar xvf f5-cnf-images-1.2.0.tgz
List the extracted Helm charts and software images:
ls -1R
The file list shows a new tar directory with the following files:
f5-cnf-crds-n6lan-0.145.3-0.0.12.tgz f5-cnf-images-1.2.0.tgz f5-cnf-tarball-1.2.0.tgz tar ./tar: cnf-docker-images.tgz cwc-0.11.1-0.0.18.tgz f5-cert-gen-0.9.1+0.0.2.tgz f5-cert-manager-0.22.9-0.0.3.tgz f5-crdconversion-0.4.8-0.0.9.tgz f5-dssm-0.27.16-0.0.16.tgz f5-toda-fluentd-1.23.3-0.0.9.tgz f5ingress-v0.434.1-0.0.92.tgz rabbitmq-0.2.0.tgz
Install CRDs¶
Use the following steps to extract and install the new CNF CRDs.
List the CNF CRD bundle:
ls -1 | grep crd
The file list shows CRD bundle:
f5-cnf-crds-n6lan-0.145.3-0.0.12.tgz
Note: The CRDs install process has been changed. Please ensure to install CRDs now using the helm install, as shown in Step 2.
Install the CRDs:
helm install f5crds f5-cnf-crds-n6lan-0.145.3-0.0.12.tgz -n default
Note the command output: Newly installed CRDs will be indicated by created, and updated CRDs will be indicated by configured:
customresourcedefinition.apiextensions.k8s.io/f5-big-alg-ftps.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-alg-pptps.k8s.f5net.com configured customresourcedefinition.apiextensions.k8s.io/f5-big-alg-rtsps.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-alg-tftps.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-cne-addresslists.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-cne-datagroups.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-cne-portlists.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-cne-snatpools.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-context-globals.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-context-secures.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-ddos-policies.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-dns-apps.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-dns-caches.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-fastl4-settings.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-fw-policies.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-ips-policies.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-log-hslpubs.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-log-profiles.k8s.f5net.com configured customresourcedefinition.apiextensions.k8s.io/f5-big-nat-policies.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-net-staticroutes.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-net-vlans.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-tcp-settings.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-udp-settings.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-zerorating-policies.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-certificaterequests.cm.f5co.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-certificates.cm.f5co.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-challenges.acme.cm.f5co.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-clusterissuers.cm.f5co.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-issuers.cm.f5co.k8s.f5net.com unchanged customresourcedefinition.apiextensions.k8s.io/f5-big-orders.acme.cm.f5co.k8s.f5net.com unchanged
List the installed CNFs CRDs:
oc get crds | grep f5
The CRD listing will contain the full list of CRDs:
certificaterequests.cm.f5co.k8s.f5net.com 2023-01-24T19:03:03Z certificates.cm.f5co.k8s.f5net.com 2023-01-24T19:03:03Z challenges.acme.cm.f5co.k8s.f5net.com 2023-01-24T19:03:03Z clusterissuers.cm.f5co.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-alg-ftps.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-alg-pptps.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-alg-rtsps.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-alg-tftps.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-cne-addresslists.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-cne-datagroups.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-cne-downloaders.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-cne-portlists.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-cne-snatpools.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-context-globals.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-context-secures.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-ddos-globals.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-ddos-profiles.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-dns-apps.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-dns-caches.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-fastl4-settings.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-fw-policies.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-ips-policies.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-log-hslpubs.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-log-profiles.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-nat-policies.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-net-staticroutes.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-net-vlans.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-tcp-settings.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-udp-settings.k8s.f5net.com 2023-01-24T19:03:03Z f5-big-zerorating-policies.k8s.f5net.com 2023-01-24T19:03:03Z issuers.cm.f5co.k8s.f5net.com 2023-01-24T19:03:03Z orders.acme.cm.f5co.k8s.f5net.com 2023-01-24T19:03:03Z
Upload the images¶
Use the following steps to upload the CNFs software images to a local container registry.
Install the CNFs images to your workstation’s Podman image store:
podman load -i tar/cnf-docker-images.tgz
List the CNF 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.434.1-0.0.92 fda6e3a78e52 local.registry/f5dr-img-init v0.10.9 1cfa684e26f8 local.registry/f5dr-img v0.10.9 1b904a8acffd local.registry/tmm-img v0.893.0-0.0.21 bf6481d581f8 local.registry/f5-debug-sidecar v7.217.1 405d6d3e8a98 local.registry/spk-cwc v0.30.3-0.0.8 9ed3a4cc23fe local.registry/rabbit v0.4.1 17df2d791bb9 local.registry/f5-dssm-upgrader 1.2.4 f4958f6209f2 local.registry/f5-toda-tmstatsd v1.9.9-0.0.1 627cf845444a local.registry/f5-fluentbit v0.8.1-0.0.4 760fcc302106 local.registry/f5-license-helper v0.10.0-0.0.2 7dd2859c10b6 local.registry/f5-dssm-store v1.25.18 4b8d98215094 local.registry/f5-l4p-engine v1.100.27 f8c32f4269ff local.registry/f5-nsec-ips-daemon v1.7.6-0.0.4 4dfa5525b971 local.registry/f5-fluentd v1.5.6 0bb4e5abb899 local.registry/tmrouted-img v0.12.0 e4c2fe04a331 local.registry/cert-manager-ctl 2.2.3 48f768b562b4 local.registry/cert-manager-webhook 2.2.3 edec31deeece local.registry/cert-manager-cainjector 2.2.3 100c82bbf515 local.registry/cert-manager-controller 2.2.3 86b90770dd0b local.registry/opentelemetry-collector 0.75.0 00fe8f105583 local.registry/f5-csm-qkview v26.18.1 f4310f499d34 local.registry/crdupdater v0.4.0-0.0.4 ea8aa2d04604 local.registry/f5-downloader v1.6.4 f6f9ef0c4bed local.registry/init-certmgr v0.22.9-0.0.3 67f0cd0f35aa local.registry/f5-cert-client v2.3.4 6bcc294db104 local.registry/f5-blobd v0.12.3 7eb092e31d08 local.registry/crd-conversion v1.31.3-0.0.1 206d9589dfc6
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.434.1-0.0.92 image is tagged and pushed to the remote registry registry.com:
podman tag local.registry/f5ingress:v0.434.1-0.0.92 registry.com/f5ingress:v9.2.11
podman push registry.com/f5ingress:v9.2.11
Note: If you encounter the “insufficient UIDs or GIDs available in user namespace” error while pushing the Docker image, kindly use the following command:
A. If you are pushing an image, use this command:
podman --storage-opt overlay.ignore_chown_errors=true push <registry>/<image name>:<version>
Example:
podman --storage-opt overlay.ignore_chown_errors=true push artifactory.f5net.com/f5-mbip-docker/f5-nsec-ips-daemon:v1.7.6-0.0.4
B. If you still encounter the error while pushing the image, increase the subuids and subgids range to larger values. Make sure the subuids and subgids fit within the required range.
Example:
sudo usermod --add-subuids 200000-2010000000 <USERNAME>
sudo usermod --add-subgids 200000-2010000000 <USERNAME>
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 cnfadmin:cnfadmin
"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 CNFs Cert Manager guide to secure CNFs communications.
Feedback¶
Provide feedback to improve this document by emailing cnfdocs@f5.com.