Skip to content

Latest commit

 

History

History
186 lines (140 loc) · 8.61 KB

downloads.md

File metadata and controls

186 lines (140 loc) · 8.61 KB

MyF5 Software Downloads & GeoDB Automation Guide

The MyF5 Software Downloads engine provides programmatic access to the authoritative F5 software catalog and artifact delivery network.


Catalog Architecture & Hierarchy

The MyF5 software catalog is structured hierarchically across five tiers:

Product Family (e.g., BIG-IP, NGINX, BIG-IQ)
  └── Product Line (e.g., big-ip_v17.x, big-ip_v16.x)
        └── Product Version (e.g., 17.1.1, 16.1.4)
              └── Container / Category (e.g., Virtual Edition, GeoLocationUpdates, Hotfix)
                    └── Download File (e.g., BIGIP-17.1.1-0.0.6.ALL.qcow2.tar.gz)

Container Categories

myf5 automatically tags and categorizes download containers based on artifact purpose:

  • Base ISO / Virtual Edition (VE): Full appliance installation images (.iso, .ova, .qcow2, .vhd).
  • GeoLocation Updates (GEODB): Digital Envoy NetAcuity GeoIP packages (Edge and Pulse variants, AskF5 K11176 / K78974041) for BIG-IP AFM, ASM/Advanced WAF, APM, and DNS.
  • Hotfix (HOTFIX): Maintenance patches and security point releases.
  • Supplemental (SUPPLEMENTAL): MIB files, signature packages, and utilities.

Automated GeoDB Download Workflow

BIG-IP systems rely on regular updates to their GeoLocation databases for geo-blocking, traffic policy enforcement, and client localization. myf5 enables headless, scheduled automation of these downloads.

1. Identify Latest GeoDB Container & File

# Query the available containers under TMOS v17.x
myf5 downloads containers BIG-IP big-ip_v17.x 17.1.1

# List files in the GeoLocationUpdates container
myf5 downloads files BIG-IP big-ip_v17.x 17.1.1 "GeoLocationUpdates"

2. Automated Download Script (Cron / CI/CD)

The following headless script can be executed as a weekly cron job or CI/CD task to retrieve the latest GeoDB package:

#!/usr/bin/env bash
set -euo pipefail

# Ensure credentials are in environment or ~/.f5api_credentials
export F5_CLIENT_ID="${F5_CLIENT_ID:-}"
export F5_CLIENT_SECRET="${F5_CLIENT_SECRET:-}"

TARGET_DIR="/var/downloads/geodb"
mkdir -p "${TARGET_DIR}"

echo "==> Fetching latest GeoLocation update package..."
# The container zip archive bundles Digital Envoy RPM components (Region, ISP, Org)
myf5 downloads get BIG-IP big-ip_v17.x 17.1.1 \
    "GeoLocationUpdates" \
    "ip-geolocation-default.zip" \
    -o "${TARGET_DIR}/ip-geolocation-default.zip"

echo "==> GeoDB downloaded and verified: ${TARGET_DIR}/ip-geolocation-default.zip"
# Note: On the appliance, unpack the archive in /shared/tmp and apply RPMs using geoip_update_data -f

End-to-End Download & Appliance Push in One Step

Instead of executing download, checksum verification, and appliance file transfer as separate decoupled steps, myf5 downloads get natively supports post-download appliance push via --push <host>.

Cryptographic Integrity Guarantee

When --push is specified:

  1. The payload streams from the official MyF5 CDN mirror to local disk with constant memory footprint (< 10 MB RAM).
  2. The SHA-256 hash is computed in real time via io.TeeReader.
  3. The downloaded image is validated against the authoritative SHA-256 checksum from the MyF5 catalog.
  4. Only upon successful cryptographic validation, myf5 initiates the push to the target appliance. If the download checksum fails or is interrupted, the appliance transfer is aborted immediately.
MyF5 CDN ---> io.TeeReader ---> SHA-256 Checksum Verification
                  │                          │
                  ▼                          ▼ [Checksum Valid]
          Local Disk Image        ------------------------> Stream to Appliance
                                                             (iControl REST or SCP)

Push Options on myf5 downloads get

Flag Default Description
--push <host> Required for push Target BIG-IP or BIG-IQ appliance IP, hostname, or URL.
--push-method <method> icontrol Transfer protocol: icontrol (HTTPS) or scp (SSH).
--push-dest <path> /shared/images or /var/tmp Remote directory on appliance (e.g., /shared/images or /shared/GeoIP).
--push-target <target> BIG-IP Appliance operating system type: BIG-IP or BIG-IQ.
--push-user <user> $BIGIP_USER / "admin" Appliance administrative user.
--push-port <port> 443 (iControl) / 22 (SCP) Appliance management port.
--push-key <key> Auto-detected SSH private key path for SCP authentication.
--apply-geoip false Automatically extract and apply GeoIP RPMs to TMM via geoip_update_data post-upload.

Practical Examples

1. Download BIG-IP ISO and Push Directly to /shared/images

myf5 downloads get BIG-IP big-ip_v17.x 17.1.1 \
    "Base Software & ISO Releases" "BIGIP-17.1.1-0.0.6.iso" \
    -o /var/tmp/BIGIP-17.1.1.iso \
    --push 10.1.1.4 \
    --push-method icontrol \
    --push-dest /shared/images

2. Automated Download & Push of Updated GeoDB Package

Stage the update archive in /var/tmp on the appliance (supported by both iControl REST and SCP whitelist):

myf5 downloads get BIG-IP big-ip_v17.x 17.1.1 \
    "GeoLocationUpdates" "ip-geolocation-default.zip" \
    -o /var/tmp/ip-geolocation-default.zip \
    --push 10.1.1.4 \
    --push-method scp \
    --push-dest /var/tmp

Post-transfer on BIG-IP: Unpack the .zip archive in /shared/tmp/ and execute geoip_update_data -f <rpm_path> for each component RPM, then verify via geoip_lookup <ip> and tmsh load sys geoip (see Appliance Push Guide).

3. Download Engineering Hotfix and Push to BIG-IQ Software Repository

myf5 downloads get BIG-IP big-ip_v17.x 17.1.1 \
    "Hotfixes & Patches" "Hotfix-BIGIP-17.1.1.1.0.0.2-ENG.iso" \
    -o /var/tmp/Hotfix-BIGIP-17.1.1.1.0.0.2-ENG.iso \
    --push 192.0.2.50 \
    --push-target bigiq \
    --push-method scp \
    --push-dest /shared/images

For complete technical details on appliance transfer mechanisms, refer to the Appliance Push Guide.


High-Performance Streaming Pipeline

Traditional HTTP clients buffer response payloads into system memory before writing to disk. For multi-gigabyte ISOs and disk images (2.5 GB to 10+ GB), this leads to high memory pressure or out-of-memory (OOM) faults.

myf5 uses a constant-RAM streaming pipeline:

HTTP TLS Stream ---> io.TeeReader ---> SHA-256 Hasher
                            |
                            v
                    os.File (Disk Write)

Key Engineering Properties

  1. Constant Memory Footprint: Allocates a fixed 64 KB transfer buffer; memory usage stays under 10 MB RAM regardless of image size.
  2. Single-Pass Checksumming: Computes SHA-256 digests in real time as data streams from the network, eliminating a second disk read pass.
  3. Atomic File Promotion: Streams data into a .part temporary file. The file is validated against authoritative API checksums before being atomically renamed to the final destination, preventing partially downloaded or corrupted files from being used.

Regional Mirror Selection

The MyF5 Downloads API generates signed CDN download URLs distributed across global geographic regions:

  • USA - EAST COAST (Default Americas CloudFront distribution)
  • IRELAND (European CloudFront distribution)

myf5 automatically selects the optimal mirror for low latency and high bandwidth, while validating the SHA-256 digest regardless of mirror location.


API Endpoint & Gateway Routing

All MyF5 Software Downloads API endpoints are served from https://api.software.downloads.f5.com (documented in K15202) under the gateway route prefix:

/v1/downloads-management/v1/downloads/...

The leading /v1 represents the API gateway route version and the inner /v1 represents the Downloads service version (defined in downloads.DownloadsPrefix).

Client Architecture

  • Authoritative Endpoint: myf5-cli connects to https://api.software.downloads.f5.com by default.
  • No Query Key: Requests authenticate using the OAuth 2.0 Bearer token and do not include a k query parameter.
  • OAuth 2.0 CIAM Alignment:
    • Primary token issuer (Auth0): https://idp.identity.f5.com/oauth/token
    • Dedicated Okta CIAM authorization server: https://identity.account.f5.com/oauth2/ausp95yxb4ShxMGvW357/v1/token with scope myf5_scope and audience api://ciam-api-myf5.
  • Resilience & Rate-Limit Backoff: Automatically retries transient HTTP 429 Too Many Requests responses with backoff and supports fallback routing if required.