Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Terraform variable reference

Auto-generated by go run ./tools/refgen/tfvars-md > book/src/29-terraform-variable-reference.md. Re-run on every terraform/variables.tf change.

Every variable below is settable via terraform.tfvars, -var, -var-file, or (for sensitive values) the corresponding TF_VAR_<name> environment variable. Variables with _required_ defaults must be set explicitly. See Chapter 13 for how roksbnkctl threads these through the workspace config.

Root module variables

Source: terraform/variables.tf

VariableTypeDefaultDescriptionSensitive
ibmcloud_api_keystringrequiredIBM Cloud API keyyes
ibmcloud_cluster_regionstring"ca-tor"IBM Cloud region for all cluster resourcesno
ibmcloud_resource_groupstring"default"IBM Cloud resource group nameno
create_roks_clusterbooltrueCreate a new ROKS cluster. When false, supply roks_cluster_id_or_name instead.no
cluster_public_gatewaybooltrueAttach a public gateway to each cluster subnet for worker Internet egress. true (default) keeps current behavior; false builds a private, disconnected cluster with no egress (operator must supply private connectivity — VPEs / private service endpoints — for image pulls and IBM Cloud services).no
roks_cluster_id_or_namestring""ID or name of an existing ROKS cluster — used when create_roks_cluster = falseno
create_roks_transit_gatewaybooltrueCreate Transit Gateway and VPC connectionsno
create_roks_registry_cos_instancebooltrueCreate Cloud Object Storage instance for the OpenShift image registryno
deploy_cert_managerbooltrueWhen true, the cert_manager module’s helm/null_resource bring-up runs. Forced false by writeBnkPhaseOverrideAt when cluster-outputs.json exists (cluster phase already deployed cert_manager; trial phase consumes it via outputs that resolve to null on the bnk-phase apply, and downstream gates fall back to "direct-apply").no
roks_cluster_vpc_namestring"tf-cluster-vpc"Name of the cluster VPCno
openshift_cluster_namestring"tf-openshift-cluster"Name of the OpenShift clusterno
openshift_cluster_versionstring"4.21"OpenShift cluster version as a BARE major.minor prefix (e.g. “4.20”). Empty uses the latest available.no
roks_workers_per_zonenumber1Number of worker nodes per availability zoneno
roks_min_worker_vcpu_countnumber16Minimum vCPU count when auto-selecting the worker node flavorno
roks_min_worker_memory_gbnumber64Minimum memory in GB when auto-selecting the worker node flavorno
roks_cos_instance_namestring"tf-openshift-cos-instance"Name of the COS instance for the OpenShift image registryno
roks_transit_gateway_namestring"tf-tgw"Name of the Transit Gateway. Must reference an existing TGW when create_roks_transit_gateway = false and testing_create_tgw_jumphost = true.no
use_existing_cluster_vpcboolfalseReuse an existing cluster VPC instead of creating one. roksbnkctl sets this true in the second (bnk/testing) phase when cluster-outputs.json exists; the cluster phase leaves it false (create).no
existing_cluster_vpc_idstring""ID of the existing cluster VPC (used only when use_existing_cluster_vpc = true) — sourced from cluster-outputs.json vpc_id.no
install_cert_managerbooltrueInstall cert-manager. When false, cert_manager_namespace is passed directly to flo.no
cert_manager_namespacestring"cert-manager"Kubernetes namespace for cert-managerno
cert_manager_versionstring"v1.17.3"cert-manager Helm chart versionno
ibmcloud_cos_resource_groupstring""Resource group holding the supply-chain COS instance. Empty resolves the workspace’s own resource group, which is the pre-#295 behaviour. Set it when the supply chain lives centrally (typically default) and the workspace was placed elsewhere.no
ibmcloud_cos_bucket_regionstring"us-south"IBM Cloud region where the COS bucket is locatedno
ibmcloud_cos_instance_namestring"bnk-supply-chain"IBM Cloud COS instance nameno
ibmcloud_resources_cos_bucketstring"bnk-artifacts"IBM Cloud COS bucket containing FAR auth key and JWT filesno
deploy_bnkbooltrueDeploy BIG-IP Next for Kubernetes — creates flo, cne_instance, and license. When false all three modules are skipped.no
far_repo_urlstring"repo.f5.com"FAR repository URL for Docker and Helm imagesno
far_chart_repo_urlstring""Chart-pull host for the air-gap mirror (helm_release repository + manifest pull). Empty falls back to far_repo_url.no
far_image_repo_urlstring""Image-pull host for the air-gap mirror (image.repository + CNEInstance spec.registry.uri). Empty falls back to far_repo_url.no
use_registry_mirrorboolfalsePull charts + images from the registry mirror instead of FAR. The far-secret dockerconfig is dropped; how pods then authenticate depends on the mirror: an in-cluster/ICR mirror authorizes by RBAC and needs no pull secret, while an EXTERNAL mirror (Harbor, Artifactory) gets a mirror-secret dockerconfig built from registry_mirror_username/password. A private mirror therefore needs no anonymous/public project.no
registry_mirror_usernamestring""Basic-auth username for an EXTERNAL registry mirror (e.g. a Harbor robot/admin). Empty → the mirror is the in-cluster/ICR registry, which authenticates via the kube token / IAM key instead.no
registry_mirror_passwordstring""Basic-auth password/token for an external registry mirror. When set (with use_registry_mirror), chart and image pulls authenticate to the mirror with these credentials instead of the in-cluster kube token.yes
f5_bigip_k8s_manifest_versionstring"2.3.0-3.2598.3-0.0.170"Version of the f5-bigip-k8s-manifest chart (FLO and CIS versions are extracted from this)no
f5_cne_far_auth_filestring"f5-far-auth-key.tgz"FAR auth key filename in the COS bucket (.tgz)no
f5_cne_subscription_jwt_filestring"subscription.jwt"Subscription JWT filename in the COS bucket — used by flo and licenseno
use_cos_bucketbooltrueDownload the FAR auth tarball + subscription JWT from the orchestration COS. false = use the injected far_service_account_b64 / f5_cne_subscription_jwt content instead (local files).no
far_service_account_b64string""FAR _json_key_base64 service account (base64 of the .json), injected when use_cos_bucket = false. Empty on the COS path.yes
f5_cne_subscription_jwtstring""Subscription/license JWT token content, injected when use_cos_bucket = false. Empty on the COS path (downloaded from COS instead).yes
bnk_linestring"2.3"BNK release line driving per-release resource gating (2.3 or 2.4). Derived by roksbnkctl from bnk.manifest_version — set it by hand only for a standalone terraform run.no
flo_namespacestring"f5-bnk"Kubernetes namespace for the F5 Lifecycle Operatorno
flo_utils_namespacestring"f5-utils"Kubernetes namespace for F5 utility components — used by flo, cne_instance, and license. Set equal to flo_namespace to install into ONE namespace.no
bigip_usernamestring"admin"BIG-IP username for the CIS controllerno
bigip_passwordstring"admin"BIG-IP password for the CIS controlleryes
bigip_urlstring"192.168.1.245"BIG-IP URL for the CIS controllerno
flo_trusted_profile_idstring""IBM Cloud Trusted Profile ID created by flo — wired automatically from flo output; set here to overrideno
flo_trusted_profile_sa_namestring""Kubernetes service account name the CNE controller’s IBM Cloud Trusted Profile is linked to — i.e. which service account may ASSUME the profile and act on the VPC.no
flo_trusted_profile_roleslist(string)["Viewer", "Editor"]IAM roles granted to the CNE controller’s Trusted Profile, scoped to the cluster’s OWN VPC (serviceName=is, vpcId=<cluster vpc>).no
flo_cluster_issuer_namestring""Kubernetes ClusterIssuer name created by flo — wired automatically from flo output; set here to overrideno
cneinstance_network_attachmentslist(string)["ens3-ipvlan-l2", "macvlan-conf"]Network attachment names for cne_instance — wired automatically from flo output; set here to overrideno
cneinstance_deployment_sizestring""Deployment size for CNEInstance (Tiny, Small, Medium, Large). EMPTY takes the line default: Small on 2.3, Tiny on 2.4 (what the 2.4 install guide and F5’s reference cluster use). Tiny is what the BNK 2.4 install guide uses; it is passed through unvalidated, so a size a given manifest does not define is rejected by the operator, not here.no
cneinstance_gslb_datacenter_namestring""GSLB datacenter name for CNEInstance (optional)no
cneinstance_network_zoneslist(object({[]Per-zone subnet CIDRs + TMM self-IPs (empty = use install-guide defaults)no
cneinstance_vlan_prefixlen_externalnumber0External VLAN self-IP prefix length. 0 (default) → cneinstance_vlan_prefixlen, so a deployment that does not care keeps one knob and one value.no
cneinstance_vlan_prefixlen_internalnumber0Internal VLAN self-IP prefix length. 0 (default) → cneinstance_vlan_prefixlen. See the external variable for why the two can differ.no
cneinstance_vlan_prefixlennumber24TMM self-IP prefix length (spec.prefixlen_v4) for the external/internal F5SPKVlan CRsno
cneinstance_tmm_k8s_routesstring"172.17.0.0/18"Pod CIDR TMM routes to (advanced.tmm.env TMM_K8S_ROUTES). Default is the ROKS default pod subnet.no
license_modestring"connected"License operation mode (connected, disconnected, or f5licenseproxy)no
flp_license_server_urlstring""Base URL of the in-cluster F5 License Proxy service (FLP mode only; e.g. https://f5-license-proxy.<ns>.svc.cluster.local:8443)no
license_server_root_castring""PEM of the FLP root CA, written into the licenseserver-rootca Secret so CWC trusts the proxy (FLP mode only)no
testing_create_tgw_jumphostbooltrueCreate a jumphost in a client VPC connected to the cluster via the Transit Gatewayno
testing_create_cluster_jumphostsboolfalseCreate one jumphost per availability zone directly inside the cluster VPCno
testing_ssh_key_namestring""Name of the IBM Cloud SSH key to inject into all jumphostsno
testing_jumphost_profilestring""Instance profile for all jumphosts (leave empty to auto-select based on min_vcpu_count and min_memory_gb)no
testing_jumphost_total_volume_bandwidthnumber1000Volume bandwidth (Mbps) pinned on each jumphost. IBM computes this from the profile at creation and terraform carries the stored value into a later profile change, so an unmanaged value taken from an oversized profile makes a downsize impossible (#316). 1000 is ample for jumphosts, which run curl/iperf3 and no disk-heavy work, and is below the ceiling of every profile the auto-select can pick.no
testing_min_vcpu_countnumber4Minimum vCPU count when auto-selecting the jumphost instance profileno
testing_min_memory_gbnumber8Minimum memory in GB when auto-selecting the jumphost instance profileno
testing_create_client_vpcboolfalseCreate a new client VPC for the TGW jumphost. When false, testing_client_vpc_name must reference an existing VPC.no
testing_client_vpc_namestring"tf-testing-vpc"Name of the client VPC — created when testing_create_client_vpc = true, or looked up when falseno
testing_client_vpc_regionstring"ca-tor"IBM Cloud region for the client VPC and TGW jumphostno
testing_tgw_jumphost_namestring"tf-testing-jumphost-tgw"Name of the TGW-connected jumphost instanceno
testing_cluster_jumphost_name_prefixstring"tf-testing-jumphost-cluster"Name prefix for cluster jumphosts — zone name is appended (<prefix>-<zone>)no
kubeconfig_dirstring"/work/.bnk/scratch/kubeconfig"Parent directory where ibm_container_cluster_config writes admin kubeconfigs. Each submodule appends its name as a subdir. Default is the bnk runner image’s /work mount; override for direct-on-host runs.no
scratch_dirstring"/work/.bnk/scratch"Persistent scratch directory for FLO’s FAR/manifest cross-apply artifacts. Default is the bnk runner image’s /work mount; override for direct-on-host runs.no
deploy_gatewayboolfalseMaster toggle for the Gateway phase. Off in every other phase’s override; on only for gateway up.no
deploy_flpboolfalseMaster toggle for the F5 License Proxy phase. Off in every other phase’s override; on only for flp up.no
flp_namespacestring"f5-license-proxy"Namespace the F5 License Proxy is installed into (FLP phase).no
flp_chart_versionstring""Pin for the f5-license-proxy chart version (empty → registry latest).no
flp_storage_classstring"ibmc-vpc-block-metro-10iops-tier"Dynamic StorageClass for the FLP’s PVCs (FLP phase). Default = ROKS VPC block.no
gateway_app_namespacestring"f5-app"Application namespace the Gateway + HTTPRoute serve (created by the gateway module)no
gateway_class_namestring"gateway-class"GatewayClass name. Set it to run more than one BNK GatewayClass in a cluster — GatewayClass is cluster-scoped, so two installs sharing the name collide.no
gateway_route_exampleslist(string)[]Extra route kinds to create working examples of, alongside the default HTTPRoute. Valid on BNK 2.3: GRPCRoute, L4Route. Empty (default) leaves an existing deployment byte-identical. L4Route also adds a TCP listener to the Gateway, because an L4Route cannot attach to an HTTP one.no
gateway_l4_listener_portnumber8080Port for the TCP listener added when gateway_route_examples includes L4Routeno
gateway_controller_namestring""GatewayClass controllerName. Empty → derived as f5.com/<flo_namespace>-f5-cne-controller, which is the value the CNE controller answers to. Set it only to point the GatewayClass at a controller this deployment did not install; a wrong value fails silently (the GatewayClass is never Accepted and the apply still succeeds).no
gateway_backend_servicestring"nginx-service"HTTPRoute backend Service name in the app namespaceno
gateway_backend_portnumber80HTTPRoute backend Service portno
gateway_egress_modestring"snatpool"Egress SNAT strategy: snatpool (default), automap, or bothno
gateway_client_subnet_locallist(string)[]Local-VSI client subnet CIDRs the static routes reach (cluster-VPC clients; one route per entry × zone). Empty = no local client routes. gateway up auto-derives these from the cluster jumphost subnets when unset (PRD 12).no
gateway_client_subnet_remotelist(string)[]Remote-VSI client subnet CIDRs the static routes reach (client-VPC clients over the TGW; one route per entry × zone). Empty = no remote client routes.no
gateway_vxlan_portnumber6789Egress VXLAN UDP port (also opened on the cluster security group)no
flp_node_port_accessboolfalseExpose the F5 License Proxy outside its own cluster (NodePort + worker-node-IP cert SANs), so a BNK install in a different cluster can license through it.no
flp_node_port_source_cidrslist(string)[]With flp_node_port_access: open the proxy’s NodePort on the worker security group to these CIDRs. A LIST — a multi-zone VPC has one address prefix per zone, and a consuming pod in an unlisted zone is silently dropped.no
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary. helm invokes it as the f5-license-proxy chart’s post-renderer (roksbnkctl flp postrender), so the FLP install needs no interpreter on the host. roksbnkctl sets this automatically via TF_VAR_roksbnkctl_binary; empty falls back to roksbnkctl on PATH.no
deploy_flp_vsiboolfalseDeploy the F5 License Proxy as a standalone VSI (podman pod, no k8s) instead of the helm chart. Set true only by the FLP phase in mode: vsi.no
flp_status_imagestring""Optional flp-status web UI image for the standalone FLP VSI (mirror/public ref). Empty = no status UI.no
flp_status_registry_hoststring""Registry host:port whose CA to trust so the FLP VSI can pull flp_status_image (e.g. Harbor’s <ip>).no
flp_status_registry_ca_b64string""Base64 CA cert for flp_status_registry_host.no
flp_vsi_ssh_keystring""Existing IBM Cloud VPC SSH key name to attach to the standalone FLP VSI (operator access). Empty = no key.no
flp_vsi_profilestring"bx2-4x16"VSI instance profile for the FLP (>= 4 vCPU / 8 GB).no
flp_vsi_zonestring""Zone for the FLP VSI. Empty → <region>-1.no
flp_vsi_boot_size_gbnumber100Boot volume size (GB) for the FLP VSI (>= 80).no
flp_vsi_floating_ipbooltrueAttach an operator floating IP to the FLP VSI for remote management (flp status + web UI + 8443 from another machine). Not the CWC endpoint. Reachability still gated by flp_vsi_allowed_cidrs. Default true.no
flp_vsi_management_allowed_cidrslist(string)[]Source CIDRs for the FLP VSI’s :80 flp-status web UI (read-only). Empty → 0.0.0.0/0 (open).no
flp_vsi_licensing_allowed_cidrslist(string)[]Source CIDRs for the FLP VSI’s :8443 proxy (+ :22 SSH). Empty → RFC-1918 private ranges.no
flp_vsi_allowed_cidrslist(string)[]DEPRECATED — legacy single list; seeds both management + licensing when set. Prefer the two per-plane variables.no
flp_prod_jwks_b64string""Optional override: base64 of F5’s public prod_jwks.txt. Empty → the flp_vsi module extracts it from the f5-license-proxy chart.no
flp_forward_proxy_hoststring""—no
flp_forward_proxy_portnumber0—no
flp_forward_proxy_protocolstring"http"—no
deploy_tgw_connectionboolfalseAttach the cluster’s VPC to an existing Transit Gateway. On only for the tgw phase; a no-op everywhere else.no
tgw_connection_targetstring""Existing Transit Gateway to attach the cluster VPC to, by NAME or ID. Multiple clusters passing the same value share one gateway.no
tgw_connection_namestring""Name for this cluster’s connection on the gateway (unique per gateway; prefix-derived so shared-gateway clusters don’t collide).no
cluster_absentboolfalseTrue only in the standalone FLP-VSI phase: no ROKS cluster exists or will be adopted, so all cluster data-source lookups + kube providers across modules are skipped (count=0).no
cluster_vpc_cidrstring""CIDR block the cluster VPC’s per-zone address prefixes are carved from (e.g. “10.241.0.0/16” → 10.241.0.0/18, 10.241.64.0/18, 10.241.128.0/18).no
use_existing_cluster_subnetsboolfalsePlace the cluster in subnets that already exist instead of creating them. Requires use_existing_cluster_vpc — a subnet cannot be adopted independently of its VPC.no
existing_cluster_subnet_idslist(string)[]Subnet ids to place the cluster in, one per zone, in zone order. Used only when use_existing_cluster_subnets = true. Their zones are read from the subnets themselves.no
flp_vsi_create_vpcboolfalseBuild the F5 License Proxy its own VPC instead of placing it in an existing one.no
flp_vsi_name_prefixstring""Prefix for the standalone FLP VSI’s resource names (e.g. bnk-ci → bnk-ci-flp-vsi). Empty (the default) keeps the legacy unprefixed names so an existing proxy is NOT replaced on upgrade. Set it to run more than one FLP in an account, and to bring the resources into roksbnkctl cleanup’s <prefix>-* sweep.no
flp_vsi_vpc_namestring""Name for the VPC created when flp_vsi_create_vpc = true.no
flp_vsi_subnet_cidrstring"10.250.0.0/24"Address prefix for the VPC created when flp_vsi_create_vpc = true.no
cluster_network_modestring"single-nic"How the cluster’s worker nodes are attached: single-nic (default) or multi-nic.no
testing_jumphost_allowed_cidrslist(string)[]Source CIDRs allowed to SSH (:22) to the testing jumphosts. Empty → 0.0.0.0/0 (open; access is key-only). Narrow to the operator’s public /32 on a shared account.no
testing_client_vpc_inbound_cidrslist(string)[]Source CIDRs allowed inbound to the testing client VPC’s default security group. Empty → the RFC-1918 private ranges (in-fabric test traffic arrives over the Transit Gateway).no
cluster_http_allowed_cidrslist(string)[]Source CIDRs allowed to reach :80 on the cluster security group. Empty → 0.0.0.0/0 (the ingress/ALB path is meant to be publicly reachable).no
cluster_vpc_default_sg_inbound_cidrslist(string)[]Source CIDRs allowed inbound (all protocols/ports) to the cluster VPC’s default security group. Empty → 0.0.0.0/0, the historical behaviour. Narrow to your private ranges unless a workload in this VPC needs a public source.no
cneinstance_tmm_resourcesmap(map(string)){}Overrides the TMM pod’s resource requests/limits, rendered as the CNEInstance’s advanced.tmm.resources (#203).no
cneinstance_advanced_envmap(map(string)){}Per-component environment passthrough for the BNK 2.4 CNEInstance’s advanced.<component>.env[] lists (#175).no
cneinstance_tmm_replicasnumber3Number of f5-tmm data-plane replicas (2.4). Reference: 3.no
cneinstance_watch_namespaceslist(string)["All"]Namespaces the CNE controller watches (2.4). Reference: ["All"].no
cneinstance_tmm_anti_affinitybooltrueRequire f5-tmm pods onto DIFFERENT NODES (2.4).no
cneinstance_tmm_zone_spreadbooltrueSpread f5-tmm pods across zones with maxSkew 1, DoNotSchedule (2.4). Reference: on.no
cneinstance_tmm_rolling_updatebooltruePin TMM’s rolling update to maxSurge 0 / maxUnavailable 1 (2.4).no
cneinstance_external_bigipboolfalseEnable the external BIG-IP controller (2.4). Reference: true.no
cneinstance_external_bigip_login_secretstring"f5-bigip-ctlr-login"Secret holding external BIG-IP credentials (2.4). Reference: f5-bigip-ctlr-login.no
cneinstance_cluster_identifierstring""CLUSTER_IDENTIFIER passed to the external BIG-IP controller (2.4). Empty derives from the cluster name.no
cneinstance_gateway_api_versionstring"1.5.0"GATEWAY_API_VERSION for the CNE controller (2.4). Reference: 1.5.0.no
gateway_api_bundle_urlstring""Where the Gateway API standard-install bundle is FETCHED from when the workspace has no registry mirror recorded (2.4 + gateway_api_mtls). Empty derives the upstream release asset for cneinstance_gateway_api_version.no
cneinstance_demo_modestring""advanced.demoMode.enabled.no
cneinstance_tmm_pod_labelstring"f5-tmm"Value of the app label the placement rules select f5-tmm pods by (2.4). Reference: f5-tmm.no
cneinstance_tmm_anti_affinity_topology_keystring"kubernetes.io/hostname"Node label the TMM anti-affinity rule spreads across (2.4).no
cneinstance_tmm_zone_topology_keystring"topology.kubernetes.io/zone"Node label the TMM zone spread uses (2.4). The IBM ROKS zone label. Reference: topology.kubernetes.io/zone.no
cneinstance_tmm_zone_max_skewnumber1maxSkew for the TMM zone topology-spread constraint (2.4). Reference: 1.no
cneinstance_tmm_zone_when_unsatisfiablestring"DoNotSchedule"whenUnsatisfiable for the TMM zone spread (2.4): DoNotSchedule or ScheduleAnyway. Reference: DoNotSchedule.no
cneinstance_tcp_settingsmap(string){}F5BigTcpSetting field overrides, as a flat map of field name to value.no
cneinstance_tcp_settings_namestring"sys-default-tcp"Name of the F5BigTcpSetting CR to write. Reference: sys-default-tcp.no
cneinstance_whole_cluster_overridestring""spec.wholeCluster, as a tri-state.no
roks_worker_flavorstring""Exact worker-node flavor, e.g. “cx3d.8x20”. Empty auto-selects.no
cneinstance_hugepagesboolfalseAllocate hugepages on the worker pool via the OpenShift Node Tuning Operator.no
cneinstance_hugepages_sizestring"2M"Hugepage size, e.g. 2M or 1G. TMM requests hugepages-2Mi, so 2M is the matching size.no
cneinstance_hugepages_countnumber2048Hugepages PER NODE. 2048 x 2M = 4Gi, which is what deploymentSize Small was observed to request.no
cneinstance_hugepages_node_rolestring"worker"machineconfiguration.openshift.io/role the Tuned profile applies to.no
cneinstance_hugepages_profile_namestring"bnk-hugepages"Name of the Tuned profile and CR.no
cneinstance_storage_class_namestring""StorageClass for the CNEInstance’s persistent volumes, TMM’s included. Empty leaves the CR’s own default, which resolves to the cluster default class.no

Module: cert_manager

Source: terraform/modules/cert_manager/variables.tf

VariableTypeDefaultDescriptionSensitive
ibmcloud_api_keystringrequiredIBM Cloud API Keyyes
ibmcloud_cluster_regionstring"ca-tor"IBM Cloud region where the cluster residesno
ibmcloud_resource_groupstring"default"IBM Cloud Resource Group name (leave empty to use account default)no
roks_cluster_name_or_idstringrequiredName or ID of the existing OpenShift ROKS cluster to deploy BNK ontono
cert_manager_namespacestring"cert-manager"Kubernetes namespace for cert-managerno
cert_manager_versionstring"v1.17.3"cert-manager Helm chart versionno
cert_manager_image_repositorystring""Override the cert-manager controller image repository (air-gap mirror image host). Empty leaves the chart default.no
create_roks_clusterboolfalseWhen true, cluster is being created by roks_cluster — skip plan-time cluster credential fetchno
deploy_cert_managerbooltrueWhen true, manage the cert_manager helm/null_resource bring-up. Set false in the bnk-phase override when cluster-outputs.json exists — cluster phase already provisioned cert_manager and the second phase must NOT re-manage it (would attempt kubectl delete namespace cert-manager on a subsequent bnk down).no
roks_cluster_dependency_idstringnullroks_cluster sentinel ID — when set, defers runtime_config fetch to apply time after roks_cluster completesno
kubeconfig_dirstring"/work/.bnk/scratch/kubeconfig/cert_manager"Persistent, writable dir for ibm_container_cluster_config kubeconfig downloads. Defaults to a host-bind-mounted, module-scoped path under .bnk/scratch.no
registry_mirror_usernamestring""Basic-auth username for an external registry mirror (a private Harbor/Artifactory). Empty → no mirror pull secret is created.no
registry_mirror_passwordstring""Basic-auth password for an external registry mirror. When set with image_repository, cert-manager’s pods pull with a dockerconfig secret built from it instead of anonymously.yes
cluster_absentboolfalseTrue in the standalone FLP-VSI phase: no ROKS cluster exists, so all cluster data-source lookups + kube providers are skipped (count=0).no

Module: cne_instance

Source: terraform/modules/cne_instance/variables.tf

VariableTypeDefaultDescriptionSensitive
bnk_linestring"2.3"BNK release line driving per-release resource gating (“2.3” or “2.4”).no
ibmcloud_api_keystringrequiredIBM Cloud API Keyyes
ibmcloud_cluster_regionstring"ca-tor"IBM Cloud region where the cluster residesno
ibmcloud_resource_groupstring"default"IBM Cloud Resource Group name (leave empty to use account default)no
roks_cluster_name_or_idstringrequiredName or ID of the existing OpenShift ROKS cluster to deploy BNK ontono
far_repo_urlstring"repo.f5.com"FAR Repository URL for Docker and Helm registryno
far_image_repo_urlstring""Image-pull host for the mirror (CNEInstance spec.registry.uri). Empty falls back to far_repo_url.no
use_registry_mirrorboolfalsePull charts + images from the registry mirror instead of FAR. The far-secret dockerconfig is dropped; how pods then authenticate depends on the mirror: an in-cluster/ICR mirror authorizes by RBAC and needs no pull secret, while an EXTERNAL mirror (Harbor, Artifactory) gets a mirror-secret dockerconfig built from registry_mirror_username/password. A private mirror therefore needs no anonymous/public project.no
flo_namespacestring"f5-bnk"Namespace for F5 Lifecycle Operatorno
flo_utils_namespacestring"f5-utils"Namespace for F5 utility componentsno
f5_bigip_k8s_manifest_versionstring"2.3.0-3.2598.3-0.0.170"Version of f5-bigip-k8s-manifest chart - used by flo, cneinstance modulesno
flo_trusted_profile_sa_namestring""The CNE controller service account; must match what the flo module linked.no
flo_trusted_profile_idstring""IBM IAM Trusted Profile ID for provisioning VPC routesno
flo_cluster_issuer_namestring""mTLS certificate issuer nameno
cneinstance_deployment_sizestring""Deployment size for CNEInstance (Tiny, Small, Medium, Large). EMPTY takes the line default: Small on 2.3, Tiny on 2.4 (what the 2.4 install guide and F5’s reference cluster use). Tiny is what the BNK 2.4 install guide uses.no
cneinstance_gslb_datacenter_namestring""GSLB datacenter name for CNEInstance (optional)no
cneinstance_network_attachmentslist(string)["ens3-ipvlan-l2", "macvlan-conf"]The Multus Network Attachment Definitions for the CNEInstance TMM deploymentsno
cneinstance_network_zoneslist(object({[]Per-zone subnet CIDRs + TMM self-IPs (empty = use the install-guide defaults)no
cneinstance_vlan_prefixlen_externalnumber0External VLAN self-IP prefix length; 0 inherits cneinstance_vlan_prefixlen.no
cneinstance_vlan_prefixlen_internalnumber0Internal VLAN self-IP prefix length; 0 inherits cneinstance_vlan_prefixlen.no
cneinstance_vlan_prefixlennumber24TMM self-IP prefix length (spec.prefixlen_v4) for the external/internal F5SPKVlan CRsno
cneinstance_tmm_k8s_routesstring"172.17.0.0/18"Pod CIDR TMM routes to (advanced.tmm.env TMM_K8S_ROUTES). Default is the ROKS default pod subnet.no
create_roks_clusterboolfalseWhen true, cluster is being created by roks_cluster — skip plan-time cluster credential fetchno
roks_cluster_dependency_idstringnullroks_cluster sentinel ID — when set, defers runtime_config fetch to apply time after roks_cluster completesno
flo_dependency_idstringnullflo_ready sentinel ID — pass module.flo.flo_ready_id to defer cne_instance until flo completes and CRDs are registeredno
deploy_bnkbooltrueDeploy BIG-IP Next for Kubernetes — when false the inner cneinstance module is disabled and no CNEInstance resources are createdno
kubeconfig_dirstring"/work/.bnk/scratch/kubeconfig/cne_instance"Persistent, writable dir for ibm_container_cluster_config kubeconfig downloads. Defaults to a host-bind-mounted, module-scoped path under .bnk/scratch.no
registry_mirror_passwordstring""Basic-auth password for an external registry mirror. When set with use_registry_mirror, the CNEInstance references the mirror-secret pull secret instead of pulling anonymously.yes
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary; the CNE-instance phase invokes roksbnkctl tfx <verb> in place of host curl (no interpreter, so cmd.exe execs it on Windows). Empty falls back to roksbnkctl on PATH.no
cluster_absentboolfalseTrue in the standalone FLP-VSI phase: no ROKS cluster exists, so all cluster data-source lookups + kube providers are skipped (count=0).no
cneinstance_tmm_resourcesmap(map(string)){}TMM resource requests/limits override; rendered as advanced.tmm.resources (#203).no
cneinstance_advanced_envmap(map(string)){}Per-component advanced.<component>.env passthrough (#175). See the root variable of the same name.no
cneinstance_tmm_replicasnumber3Number of f5-tmm data-plane replicas (2.4). Reference: 3.no
cneinstance_watch_namespaceslist(string)["All"]Namespaces the CNE controller watches (2.4). Reference: ["All"].no
cneinstance_tmm_anti_affinitybooltrueRequire f5-tmm pods onto DIFFERENT NODES (2.4).no
cneinstance_tmm_zone_spreadbooltrueSpread f5-tmm pods across zones with maxSkew 1, DoNotSchedule (2.4). Reference: on.no
cneinstance_tmm_rolling_updatebooltruePin TMM’s rolling update to maxSurge 0 / maxUnavailable 1 (2.4).no
cneinstance_external_bigipboolfalseEnable the external BIG-IP controller (2.4). Reference: true.no
cneinstance_external_bigip_login_secretstring"f5-bigip-ctlr-login"Secret holding external BIG-IP credentials (2.4). Reference: f5-bigip-ctlr-login.no
cneinstance_cluster_identifierstring""CLUSTER_IDENTIFIER passed to the external BIG-IP controller (2.4). Empty derives from the cluster name.no
cneinstance_gateway_api_versionstring"1.5.0"GATEWAY_API_VERSION for the CNE controller (2.4). Reference: 1.5.0.no
cneinstance_demo_modestring""advanced.demoMode.enabled.no
cneinstance_tmm_pod_labelstring"f5-tmm"Value of the app label the placement rules select f5-tmm pods by (2.4). Reference: f5-tmm.no
cneinstance_tmm_anti_affinity_topology_keystring"kubernetes.io/hostname"Node label the TMM anti-affinity rule spreads across (2.4).no
cneinstance_tmm_zone_topology_keystring"topology.kubernetes.io/zone"Node label the TMM zone spread uses (2.4). The IBM ROKS zone label. Reference: topology.kubernetes.io/zone.no
cneinstance_tmm_zone_max_skewnumber1maxSkew for the TMM zone topology-spread constraint (2.4). Reference: 1.no
cneinstance_tmm_zone_when_unsatisfiablestring"DoNotSchedule"whenUnsatisfiable for the TMM zone spread (2.4): DoNotSchedule or ScheduleAnyway. Reference: DoNotSchedule.no
cneinstance_tcp_settingsmap(string){}F5BigTcpSetting field overrides, as a flat map of field name to value.no
cneinstance_tcp_settings_namestring"sys-default-tcp"Name of the F5BigTcpSetting CR to write. Reference: sys-default-tcp.no
cneinstance_whole_cluster_overridestring""spec.wholeCluster, as a tri-state.no
cneinstance_hugepagesboolfalseAllocate hugepages on the worker pool via the OpenShift Node Tuning Operator.no
cneinstance_hugepages_sizestring"2M"Hugepage size, e.g. 2M or 1G. TMM requests hugepages-2Mi, so 2M is the matching size.no
cneinstance_hugepages_countnumber2048Hugepages PER NODE. 2048 x 2M = 4Gi, which is what deploymentSize Small was observed to request.no
cneinstance_hugepages_node_rolestring"worker"machineconfiguration.openshift.io/role the Tuned profile applies to.no
cneinstance_hugepages_profile_namestring"bnk-hugepages"Name of the Tuned profile and CR.no
cneinstance_storage_class_namestring""StorageClass for the CNEInstance’s persistent volumes. See the leaf module variable of the same name (#189).no

Module: flo

Source: terraform/modules/flo/variables.tf

VariableTypeDefaultDescriptionSensitive
bnk_linestring"2.3"BNK release line driving per-release resource gating (“2.3” or “2.4”).no
ibmcloud_api_keystringrequiredIBM Cloud API Keyyes
ibmcloud_cluster_regionstring"ca-tor"IBM Cloud region where the cluster residesno
ibmcloud_resource_groupstring"default"IBM Cloud Resource Group name (leave empty to use account default)no
roks_cluster_name_or_idstringrequiredName or ID of the existing OpenShift ROKS cluster to deploy BNK ontono
far_repo_urlstring"repo.f5.com"FAR Repository URL for Docker and Helm registryno
far_chart_repo_urlstring""Chart-pull host for the mirror (helm_release repository + manifest pull). Empty falls back to far_repo_url.no
far_image_repo_urlstring""Image-pull host for the mirror (image.repository). Empty falls back to far_repo_url.no
use_registry_mirrorboolfalsePull charts + images from the registry mirror instead of FAR. The far-secret dockerconfig is dropped; how pods then authenticate depends on the mirror: an in-cluster/ICR mirror authorizes by RBAC and needs no pull secret, while an EXTERNAL mirror (Harbor, Artifactory) gets a mirror-secret dockerconfig built from registry_mirror_username/password. A private mirror therefore needs no anonymous/public project.no
registry_mirror_usernamestring""Basic-auth username for an external registry mirror (Harbor). Empty → in-cluster/ICR mirror.no
registry_mirror_passwordstring""Basic-auth password/token for an external registry mirror; chart pulls authenticate with it when set.yes
f5_bigip_k8s_manifest_versionstring"2.3.0-3.2598.3-0.0.170"Version of the f5-bigip-k8s-manifest chart (FLO/CIS versions are extracted from this)no
use_cos_bucketbooltrueFetch FAR auth key and JWT from IBM Cloud Object Storage instead of local variablesno
far_service_account_b64string""FAR _json_key_base64 service account (base64 of the .json), injected when use_cos_bucket = falseyes
ibmcloud_cos_bucket_regionstring"us-south"IBM Cloud region where the COS bucket is locatedno
ibmcloud_cos_instance_namestring"bnk-supply-chain"IBM Cloud COS instance nameno
ibmcloud_resources_cos_bucketstring"bnk-artifacts"IBM Cloud COS bucket containing the FAR auth key and JWT filesno
f5_cne_far_auth_filestring"f5-far-auth-key.tgz"FAR auth key filename in the COS bucket (.tgz)no
flo_trusted_profile_sa_namestring""Service account the CNE controller Trusted Profile is linked to.no
flo_trusted_profile_roleslist(string)["Viewer", "Editor"]IAM roles for the CNE controller Trusted Profile, scoped to the cluster VPC.no
flo_namespacestring"f5-bnk"Namespace for F5 Lifecycle Operatorno
flo_utils_namespacestring"f5-utils"Namespace for F5 utility componentsno
cert_manager_namespacestring"cert-manager"Kubernetes namespace for cert-manager - used by cert-manager, flo modulesno
bigip_usernamestring"admin"BIG-IP username for CIS controller loginno
bigip_passwordstring"admin"BIG-IP password for CIS controller loginyes
bigip_urlstring"https://192.168.1.245"BIG-IP URL for CIS controller loginno
create_roks_clusterboolfalseWhen true, cluster is being created by roks_cluster — skip plan-time cluster credential fetchno
roks_cluster_dependency_idstringnullroks_cluster sentinel ID — when set, defers runtime_config fetch to apply time after roks_cluster completesno
cert_manager_dependency_idstringnullcert_manager ready sentinel ID — when set, blocks flo inner module until cert-manager CRDs are availableno
deploy_bnkbooltrueDeploy BIG-IP Next for Kubernetes — when false the inner flo module is disabled and no FLO resources are createdno
kubeconfig_dirstring"/work/.bnk/scratch/kubeconfig/flo"Persistent, writable dir for ibm_container_cluster_config kubeconfig downloads. Defaults to a host-bind-mounted, module-scoped path under .bnk/scratch.no
scratch_dirstring"/work/.bnk/scratch"Persistent scratch directory for FAR/manifest cross-apply artifacts. Default is the bnk runner image’s /work mount.no
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary; the FLO phase invokes roksbnkctl tfx <verb> in place of host curl/tar (no interpreter, so cmd.exe execs it on Windows). Empty falls back to roksbnkctl on PATH.no
cluster_absentboolfalseTrue in the standalone FLP-VSI phase: no ROKS cluster exists, so all cluster data-source lookups + kube providers are skipped (count=0).no
ibmcloud_cos_resource_groupstring""Resource group holding the supply-chain COS instance. Empty resolves the workspace’s own resource group (#295).no

Module: flp

Source: terraform/modules/flp/variables.tf

VariableTypeDefaultDescriptionSensitive
deploy_flpboolfalseDeploy the F5 License Proxy. Off in every other phase’s override; on only for flp up. When false the module is a complete no-op.no
create_roks_clusterboolfalseWhen true the cluster is being created in this same apply (FLP never runs then); gates the plan-time cluster-config fetch.no
roks_cluster_name_or_idstring""Name or id of the existing ROKS cluster to deploy the FLP into.no
roks_cluster_dependency_idanynullDependency handle from the cluster phase, deferring apply until the cluster is ready.no
kubeconfig_dirstring""Directory the ibm_container_cluster_config data source writes the kubeconfig into.no
ibmcloud_api_keystring""IBM Cloud API key (COS/IAM auth + provider config).yes
ibmcloud_cluster_regionstring""Region of the ROKS cluster (ibm provider).no
ibmcloud_resource_groupstring""Resource group containing the COS instance (empty = default group).no
ibmcloud_cos_instance_namestring""COS service instance holding the FAR auth tarball + subscription JWT.no
ibmcloud_resources_cos_bucketstring""COS bucket holding the FAR auth tarball + subscription JWT.no
ibmcloud_cos_bucket_regionstring""Region of the COS bucket.no
f5_cne_far_auth_filestring"f5-far-auth-key.tgz"FAR auth tarball object key in the COS bucket (the _json_key_base64 SA lives inside).no
f5_cne_subscription_jwt_filestring"subscription.jwt"Subscription JWT object key in the COS bucket — seeds flp-jwt-secret.no
scratch_dirstring"/tmp/roksbnkctl-flp"Working directory for the FAR-auth download/extract.no
far_repo_urlstring"repo.f5.com"FAR registry host (fallback when no mirror).no
far_chart_repo_urlstring""Mirror host for chart pulls (empty → coalesces to far_repo_url).no
far_image_repo_urlstring""Mirror host for image pulls (empty → coalesces to far_repo_url).no
use_registry_mirrorboolfalsePull charts + images from the registry mirror instead of FAR. The far-secret dockerconfig is dropped; how pods then authenticate depends on the mirror: an in-cluster/ICR mirror authorizes by RBAC and needs no pull secret, while an EXTERNAL mirror (Harbor, Artifactory) gets a mirror-secret dockerconfig built from registry_mirror_username/password. A private mirror therefore needs no anonymous/public project.no
registry_mirror_usernamestring""Basic-auth username for an EXTERNAL registry mirror (e.g. a Harbor robot/admin). Empty → in-cluster/ICR mirror (kube-token/IAM auth).no
registry_mirror_passwordstring""Basic-auth password/token for an external registry mirror. When set (with use_registry_mirror), chart + image pulls authenticate with it instead of the kube token.yes
flp_namespacestring"f5-license-proxy"Namespace to install the F5 License Proxy into.no
flp_chart_versionstring""Pin the f5-license-proxy chart version. Empty (the default) → resolved from the BNK manifest, which lists charts/f5-license-proxy for the release — same as the FLO and CIS charts. Set this only to override the manifest.no
f5_bigip_k8s_manifest_versionstring""BNK manifest version. The f5-license-proxy chart version is read out of this manifest when flp_chart_version is empty.no
flp_node_port_accessboolfalseExpose the proxy OUTSIDE its own cluster so a BNK install in a different cluster can license through it. The chart’s Service is already type NodePort (30001), but it hardcodes externalTrafficPolicy: Local — with one replica only the node running the pod answers — so this flips it to Cluster and adds the worker node IPs to the proxy’s server certificate (without them the remote CWC rejects the TLS handshake).no
flp_node_port_source_cidrslist(string)[]With flp_node_port_access: open the proxy’s NodePort on the cluster’s worker security group to these CIDRs (the consuming cluster’s subnets). A LIST, because a multi-zone VPC carries one address prefix per zone — allowing only one means a consuming pod scheduled in another zone is silently dropped at the security group. Empty leaves the security group untouched.no
flp_storage_classstring"ibmc-vpc-block-metro-10iops-tier"Dynamic StorageClass for the FLP’s PVCs. The chart ships hostPath PVs (incompatible with ROKS multi-node/non-root); a post-renderer drops them and repoints the PVCs here, so the CSI driver provisions block volumes chowned to fsGroup. Default is the ROKS VPC block default.no
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary, which helm invokes as the f5-license-proxy chart’s POST-RENDERER (roksbnkctl flp postrender). roksbnkctl sets this to its own path automatically via TF_VAR_roksbnkctl_binary; empty falls back to roksbnkctl on PATH for a direct terraform apply. Replaces a generated python script, which made python3 an undeclared runtime dependency of the FLP phase — absent in the tools-runner container.no
ibmcloud_cos_resource_groupstring""Resource group holding the supply-chain COS instance. Empty resolves the workspace’s own resource group (#295).no

Module: flp_vsi

Source: terraform/modules/flp_vsi/variables.tf

VariableTypeDefaultDescriptionSensitive
deploy_flp_vsiboolfalseMaster toggle — when false the whole module is a no-op (count=0). Set true only by the FLP phase in mode: vsi.no
ibmcloud_api_keystringrequiredIBM Cloud API key (provider + COS/IAM REST auth).yes
ibmcloud_cluster_regionstringrequiredRegion of the ROKS cluster / where the FLP VSI is provisioned.no
ibmcloud_resource_groupstring""Resource group for the VSI + network (empty = account default).no
flp_vsi_profilestring"bx2-4x16"VSI instance profile (>= 4 vCPU / 8 GB).no
flp_vsi_zonestring""Zone for the VSI (e.g. us-south-1). Empty → <region>-1.no
flp_vsi_boot_size_gbnumber100Boot volume size in GB (>= 80).no
flp_vsi_floating_ipbooltrueAttach an operator floating IP to the FLP VSI for remote management — running roksbnkctl flp status and reaching the :80 web UI + :8443 proxy from another machine. NOT the CWC endpoint (the cluster always reaches the proxy privately). The floating IP is added to the leaf-cert SAN; reachability is still gated by flp_vsi_allowed_cidrs. Default true.no
flp_vsi_management_allowed_cidrslist(string)[]Source CIDRs allowed to reach the :80 flp-status web UI (read-only status). Empty → 0.0.0.0/0 (open — the page carries no secrets).no
flp_vsi_licensing_allowed_cidrslist(string)[]Source CIDRs allowed to reach the :8443 licensing proxy (and :22 SSH). Empty → the RFC-1918 private ranges (the cluster reaches the proxy privately over the VPC / Transit Gateway).no
flp_vsi_allowed_cidrslist(string)[]DEPRECATED — legacy single list. When set, seeds BOTH flp_vsi_management_allowed_cidrs and flp_vsi_licensing_allowed_cidrs. Prefer the two per-plane variables. Empty → the per-plane defaults apply.no
existing_cluster_vpc_idstring""The cluster VPC id (from cluster-outputs.json) the FLP VSI joins so the CWC reaches it directly.no
flp_vsi_name_prefixstring""Prefix for the FLP VSI’s resource names, e.g. "bnk-ci" yields bnk-ci-flp-vsi. Empty (the default) keeps the legacy unprefixed names, so an existing proxy is not replaced on upgrade. Set it to run more than one standalone FLP in an account, and to make the resources visible to roksbnkctl cleanup.no
far_repo_urlstring"repo.f5.com"FAR repository host for the FLP chart pulls. Same value as the root far_repo_url.no
flp_image_registrystring""FAR image host prefix. Empty (the default) derives <far_repo_url>/images, so the image host follows the chart host instead of pinning repo.f5.com independently.no
f5_bigip_k8s_manifest_versionstringrequiredBNK manifest version — the f5-license-proxy chart/image tag is resolved from it (like the helm path) when flp_chart_version is empty.no
flp_chart_versionstring""Pin the f5-license-proxy chart/image tag. Empty → resolved from the BNK manifest.no
flp_vault_image_tagstring"2.0.0"Tag for the vault image.no
f5_cert_urlstring"https://product.apis.f5.com/ee/v1"—no
f5_entitlement_urlstring"https://product-s.apis.f5.com/ee/v1"—no
f5_initial_config_urlstring"https://product-s.apis.f5.com/ee/v1"—no
mode_of_operationstring"connected"—no
flp_forward_proxy_hoststring""—no
flp_forward_proxy_portnumber0—no
flp_forward_proxy_protocolstring"http"—no
ibmcloud_cos_instance_namestring"bnk-supply-chain"—no
ibmcloud_resources_cos_bucketstring"bnk-artifacts"—no
ibmcloud_cos_bucket_regionstring"us-south"—no
f5_cne_far_auth_filestring"f5-far-auth-key.tgz"—no
f5_cne_subscription_jwt_filestring"subscription.jwt"—no
scratch_dirstring"/tmp/flp-vsi-scratch"Working dir for the FAR-auth download/extract + chart pull.no
flp_prod_jwks_b64string""Base64 of F5’s public prod_jwks.txt (JWT signature verification). Supplied by the FLP phase, which extracts it from the f5-license-proxy chart.no
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary; the FLP-VSI phase invokes roksbnkctl tfx <verb> in place of host curl/tar (no interpreter, so cmd.exe execs it on Windows). Empty falls back to roksbnkctl on PATH.no
use_cos_bucketbooltrueTrue: pull the FAR tarball + subscription JWT from COS. False (disconnected): use far_service_account_b64 + f5_cne_subscription_jwt supplied by the root from local files.no
far_service_account_b64string""Base64 FAR service account (from bnk.far_auth_local_file), used when use_cos_bucket=false.no
f5_cne_subscription_jwtstring""Subscription JWT contents (from bnk.subscription_jwt_local_file), used when use_cos_bucket=false.no
flp_vsi_ssh_keystring""Existing VPC SSH key name to attach to the FLP VSI (operator access). Empty = no key.no
flp_vsi_create_vpcboolfalseBuild the proxy its own VPC, address prefix and public gateway instead of placing it in one that already exists. Default false keeps existing workspaces byte-identical.no
flp_vsi_vpc_namestring""Name for the VPC created when flp_vsi_create_vpc = true. Empty uses flp-vsi-vpc.no
flp_vsi_subnet_cidrstring"10.250.0.0/24"Address prefix for the VPC created when flp_vsi_create_vpc = true. Must not overlap anything the consuming clusters can already route to.no
ibmcloud_cos_resource_groupstring""Resource group holding the supply-chain COS instance. Empty resolves the workspace’s own resource group (#295).no

Module: gateway

Source: terraform/modules/gateway/variables.tf

VariableTypeDefaultDescriptionSensitive
bnk_linestring"2.3"BNK release line driving per-release resource gating (“2.3” or “2.4”).no
ibmcloud_api_keystringrequiredIBM Cloud API keyyes
ibmcloud_cluster_regionstringrequiredIBM Cloud region the cluster runs in (zone names derive as <region>-1/2/3)no
roks_cluster_name_or_idstringrequiredExisting ROKS cluster name or id the Gateway phase configuresno
kubeconfig_dirstring""Directory the IBM provider writes the cluster kubeconfig intono
create_roks_clusterboolfalseAlways false for the Gateway phase (it reuses an existing cluster)no
roks_cluster_dependency_idstringnullCluster-ready handle (apply-time ordering); unused gate kept for symmetryno
deploy_gatewayboolfalseMaster toggle — when false the whole Gateway phase is a no-op (count=0)no
flo_namespacestring"f5-bnk"BNK namespace (F5BnkGateway / SnatPool / Egress / StaticRoute live here)no
app_namespacestring"f5-app"Application namespace the Gateway + HTTPRoute serve (created by this module)no
cneinstance_network_zoneslist(object({[ { ext_vlan_cidr = "10.155.15.0/24" int_vlan_cidr = "10.254.99.0/24" int_snat_cidr = "10.10.11.0/24" int_vip_cidr = "10.135.15.0/24" external_selfip = "10.155.15.101" internal_selfip = "10.254.99.101" }, { ext_vlan_cidr = "10.156.16.0/24" int_vlan_cidr = "10.254.100.0/24" int_snat_cidr = "10.10.21.0/24" int_vip_cidr = "10.136.16.0/24" external_selfip = "10.156.16.101" internal_selfip = "10.254.100.101" }, { ext_vlan_cidr = "10.157.17.0/24" int_vlan_cidr = "10.254.101.0/24" int_snat_cidr = "10.10.31.0/24" int_vip_cidr = "10.137.17.0/24" external_selfip = "10.157.17.101" internal_selfip = "10.254.101.101" }, ]Per-zone subnet CIDRs (empty = install-guide defaults). Shared with the BNK phase.no
gateway_class_namestring"gateway-class"GatewayClass nameno
gateway_controller_namestring""GatewayClass controllerName. Empty (the default) DERIVES it from flo_namespace as “f5.com/<flo_namespace>-f5-cne-controller”, which is the only value the CNE controller answers to — it must equal the CNEInstance’s own name (modules/cne_instance/…/main.tf builds that as “<flo_namespace>-f5-cne-controller”). This used to be the literal “f5.com/f5-bnk-f5-cne-controller”, i.e. the DEFAULT namespace baked in as a constant, so any workspace with a non-default bnk.flo_namespace got a GatewayClass no controller ever accepted and a Gateway that never programmed. Set explicitly only to point at a controller this module did not deploy.no
gateway_bnkgateway_namestring"bnkgateway-cloud1"F5BnkGateway name (referenced by the Gateway parametersRef)no
gateway_namestring"http-gw"Gateway (gateway.networking.k8s.io) nameno
gateway_listener_portnumber80Gateway HTTP listener portno
gateway_vip_start_hostnumber100Host number in int_vip_cidr for F5BnkGateway listener startAddressno
gateway_vip_end_hostnumber120Host number in int_vip_cidr for F5BnkGateway listener endAddressno
gateway_route_namestring"http-route"HTTPRoute nameno
gateway_backend_servicestring"nginx-service"HTTPRoute backend Service name in the app namespaceno
gateway_backend_portnumber80HTTPRoute backend Service portno
gateway_route_exampleslist(string)[]Extra route kinds to create WORKING examples of, alongside the default HTTPRoute. Empty (the default) changes nothing about an existing deployment.no
gateway_l4_listener_portnumber8080Port for the TCP listener added when gateway_route_examples includes L4Routeno
gateway_egress_modestring"snatpool"Egress SNAT strategy: snatpool (default; creates the SnatPool + snatpool Egress), automap (automap Egress only), or both.no
gateway_snatpool_namestring"egress-snat-vx102"F5SPKSnatpool nameno
gateway_snat_hostnumber111Host number in int_snat_cidr for each zone’s SNAT addressno
gateway_egress_app_interfacestring"eth0"Application pod interface the Egress interceptsno
gateway_egress_tmm_interfacestring"external-vlan"TMM interface name the Egress VXLAN binds to (matches the external VLAN)no
gateway_egress_node_interfacestring"ens3"Node interface name for the Egress VXLANno
gateway_egress_mtunumber1460Egress VXLAN MTUno
gateway_vxlan_portnumber6789Egress VXLAN UDP port (also opened on the cluster security group)no
gateway_client_subnet_locallist(string)[]Local-VSI client subnet CIDRs the static routes reach (cluster-VPC clients; one F5SPKStaticRoute per entry × zone). Empty = no local client routes.no
gateway_client_subnet_remotelist(string)[]Remote-VSI client subnet CIDRs the static routes reach (client-VPC clients over the TGW; one F5SPKStaticRoute per entry × zone). Empty = no remote client routes.no
gateway_static_route_gw_hostnumber1Host number in ext_vlan_cidr used as each zone’s static-route gatewayno
gateway_infra_namestring"cloud-infra"Name of the BNK 2.4 Infra CR (gateway.k8s.f5.com/v1alpha1) in the FLO namespace.no
gateway_settings_namestring"gw-settings-common"Name of the BNK 2.4 GatewaySettings CR in the FLO namespace.no
gateway_nad_namestring"ens3-ipvlan-l2"NetworkAttachmentDefinition the 2.4 Infra CR’s external VLAN attaches to.no
gateway_egress_vxlan_portnumber6789egressDefaults.port on the 2.4 Infra CR. The CRD default is 4789; the install guide’s worked example uses 6789, which is what this defaults to so a stock install matches the vendor’s own manifest.no
gateway_egress_vxlan_subnetstring""egressDefaults.subnet on the 2.4 Infra CR. Empty leaves the controller’s default of 10.0.0.0/16.no

Module: license

Source: terraform/modules/license/variables.tf

VariableTypeDefaultDescriptionSensitive
flo_namespacestring"f5-bnk"Namespace the CNEInstance lives in, for the 2.4 post-licensing health check (#167).no
bnk_linestring"2.3"BNK release line (‘2.3’ or ‘2.4’) for per-release gating. See PRD 18 §4.no
ibmcloud_api_keystringrequiredIBM Cloud API Keyyes
ibmcloud_cluster_regionstring"ca-tor"IBM Cloud region where the cluster residesno
ibmcloud_resource_groupstring"default"IBM Cloud Resource Group name (leave empty to use account default)no
ibmcloud_cos_bucket_regionstring"us-south"IBM Cloud region where the COS bucket is locatedno
ibmcloud_cos_instance_namestring"bnk-supply-chain"IBM Cloud COS instance nameno
ibmcloud_resources_cos_bucketstring"bnk-artifacts"IBM Cloud COS bucket containing the FAR auth key and JWT filesno
roks_cluster_name_or_idstringrequiredName or ID of the existing OpenShift ROKS cluster to deploy BNK ontono
flo_utils_namespacestring"f5-utils"Namespace for F5 utility componentsno
f5_cne_subscription_jwt_filestring"subscription.jwt"Subscription JWT filename in the COS bucketno
use_cos_bucketbooltrueDownload the subscription JWT from COS. false = use the injected jwt_token content (local file).no
jwt_tokenstring""Subscription/license JWT content, injected when use_cos_bucket = false. Empty on the COS path.yes
license_modestring"connected"License operation mode (connected, disconnected, or f5licenseproxy)no
flp_license_server_urlstring""Base URL of the in-cluster F5 License Proxy (FLP mode only)no
license_server_root_castring""PEM of the FLP root CA, written to the licenseserver-rootca Secret (FLP mode only)no
create_roks_clusterboolfalseWhen true, cluster is being created by roks_cluster — skip plan-time cluster credential fetchno
roks_cluster_dependency_idstringnullroks_cluster sentinel ID — when set, defers runtime_config fetch to apply time after roks_cluster completesno
cneinstance_dependency_idstringnullcneinstance_ready_id from ws4 — when set, ensures License CRD is available before applying License CRno
deploy_bnkbooltrueDeploy BIG-IP Next for Kubernetes — when false the inner license module is disabled and no License resources are createdno
kubeconfig_dirstring"/work/.bnk/scratch/kubeconfig/license"Persistent, writable dir for ibm_container_cluster_config kubeconfig downloads. Defaults to a host-bind-mounted, module-scoped path under .bnk/scratch.no
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary; the license phase invokes roksbnkctl tfx <verb> in place of host curl (no interpreter, so cmd.exe execs it on Windows). Empty falls back to roksbnkctl on PATH.no
cluster_absentboolfalseTrue in the standalone FLP-VSI phase: no ROKS cluster exists, so all cluster data-source lookups + kube providers are skipped (count=0).no
ibmcloud_cos_resource_groupstring""Resource group holding the supply-chain COS instance. Empty resolves the workspace’s own resource group (#295).no

Module: roks_cluster

Source: terraform/modules/roks_cluster/variables.tf

VariableTypeDefaultDescriptionSensitive
ibmcloud_api_keystringrequiredIBM Cloud API keyyes
ibmcloud_cluster_regionstringrequiredIBM Cloud region for all cluster resourcesno
ibmcloud_resource_groupstring"default"IBM Cloud resource group nameno
create_roks_clusterbooltrueCreate a new ROKS cluster. When false, supply roks_cluster_id_or_name instead.no
cluster_public_gatewaybooltrueAttach public gateways for worker Internet egress. true (default) = current behavior; false = private/disconnected cluster (no egress).no
roks_cluster_id_or_namestring""ID or name of an existing ROKS cluster — used when create_roks_cluster = falseno
create_roks_transit_gatewaybooltrueCreate Transit Gateway and VPC connectionsno
create_roks_registry_cos_instancebooltrueCreate Cloud Object Storage instance for the OpenShift image registryno
roks_cluster_vpc_namestring"tf-cluster-vpc"Name of the cluster VPCno
openshift_cluster_namestring"tf-openshift-cluster"Name of the OpenShift clusterno
openshift_cluster_versionstring"4.20"OpenShift cluster version as a BARE major.minor prefix (e.g. “4.20”). Empty uses the latest available.no
roks_workers_per_zonenumber1Number of worker nodes per availability zoneno
roks_min_worker_vcpu_countnumber16Minimum vCPU count when auto-selecting the worker node flavorno
roks_min_worker_memory_gbnumber64Minimum memory in GB when auto-selecting the worker node flavorno
roks_cos_instance_namestring"tf-openshift-cos-instance"Name of the COS instance for the OpenShift image registryno
roks_transit_gateway_namestring"tf-tgw"Name of the Transit Gatewayno
use_existing_cluster_vpcboolfalseReuse an existing cluster VPC instead of creating one (forwarded to module.cluster).no
existing_cluster_vpc_idstring""ID of the existing cluster VPC (used only when use_existing_cluster_vpc = true; forwarded to module.cluster).no
kubeconfig_dirstringrequiredDirectory where ibm_container_cluster_config writes the admin kubeconfig. Must be writable; set explicitly to avoid the provider’s HOME-derived default, which resolves empty under the roksbnkctl runner.no
roksbnkctl_binarystring""Absolute path to the roksbnkctl binary; the cluster phase invokes roksbnkctl tfx <verb> in place of host curl/kubectl (no interpreter, so cmd.exe execs it on Windows). roksbnkctl sets this via TF_VAR_roksbnkctl_binary; empty falls back to roksbnkctl on PATH.no
cluster_absentboolfalseTrue only in the standalone FLP-VSI phase: no ROKS cluster exists or will be adopted, so all cluster data-source lookups + kube providers across modules are skipped (count=0).no
cluster_vpc_cidrstring""CIDR block the cluster VPC’s per-zone address prefixes are carved from (e.g. “10.241.0.0/16” → 10.241.0.0/18, 10.241.64.0/18, 10.241.128.0/18).no
use_existing_cluster_subnetsboolfalsePlace the cluster in subnets that already exist instead of creating them. Requires use_existing_cluster_vpc — a subnet cannot be adopted independently of its VPC.no
existing_cluster_subnet_idslist(string)[]Subnet ids to place the cluster in, one per zone, in zone order. Used only when use_existing_cluster_subnets = true. Their zones are read from the subnets themselves.no
cluster_http_allowed_cidrslist(string)[]Source CIDRs allowed to reach :80 on the cluster security group. Empty → 0.0.0.0/0.no
cluster_vpc_default_sg_inbound_cidrslist(string)[]Source CIDRs allowed inbound (all protocols/ports) to the cluster VPC’s default security group. Empty → 0.0.0.0/0.no
roks_worker_flavorstring""Exact worker-node flavor, e.g. “cx3d.8x20”. Empty auto-selects.no
bnk_linestring"2.3"BNK release line (2.3 / 2.4), used to pick a VALIDATED default worker flavor per line.no

Module: testing

Source: terraform/modules/testing/variables.tf

VariableTypeDefaultDescriptionSensitive
ibmcloud_api_keystringrequiredIBM Cloud API Keyyes
ibmcloud_cluster_regionstring"ca-tor"IBM Cloud region where the referenced cluster residesno
ibmcloud_resource_groupstring""IBM Cloud Resource Group name (leave empty to use account default)no
roks_cluster_name_or_idstringrequiredName or ID of the existing OpenShift ROKS clusterno
testing_create_tgw_jumphostbooltrueCreate a jumphost in a client VPC and (optionally) connect it to the cluster via a Transit Gatewayno
testing_create_cluster_jumphostsboolfalseCreate one jumphost per availability zone directly inside the cluster VPCno
testing_ssh_key_namestring""Name of the SSH key to inject into all jumphosts. Must exist in client_vpc_region (for TGW jumphost) and in ibmcloud_cluster_region (for cluster jumphosts)no
testing_jumphost_profilestring""Instance profile for all jumphosts (leave empty to auto-select from min_vcpu_count and min_memory_gb)no
testing_jumphost_total_volume_bandwidthnumber1000Volume bandwidth (Mbps) pinned on each jumphost. IBM computes this from the profile at creation and terraform carries the stored value into a later profile change, so an unmanaged value taken from an oversized profile makes a downsize impossible (#316). 1000 is ample for jumphosts, which run curl/iperf3 and no disk-heavy work, and is below the ceiling of every profile the auto-select can pick.no
testing_min_vcpu_countnumber4Minimum vCPU count when auto-selecting the instance profileno
testing_min_memory_gbnumber8Minimum memory in GB when auto-selecting the instance profileno
testing_create_client_vpcboolfalseCreate a new client VPC for the TGW jumphost. When false, client_vpc_name must reference an existing VPCno
testing_client_vpc_namestring"tf-testing-vpc"Name of the client VPC — created when create_client_vpc = true, or looked up when create_client_vpc = falseno
testing_client_vpc_regionstring"ca-tor"IBM Cloud region for the client VPC and TGW jumphostno
testing_transit_gateway_namestring""Name of an existing Transit Gateway to connect the client VPC to (leave empty to skip TGW attachment)no
testing_tgw_jumphost_namestring"tf-testing-jumphost-tgw"Name of the TGW-connected jumphost instance (used as prefix for subnet, gateway, security group, and floating IP)no
testing_cluster_jumphost_name_prefixstring"tf-testing-jumphost-cluster"Name prefix for cluster jumphosts — zone name is appended (<prefix>-<zone>)no
roks_cluster_dependency_idstringnullroks_cluster sentinel ID — when set, defers cluster/TGW data source reads to apply time after roks_cluster completesno
create_roks_clusterboolfalseSet to true when the ROKS cluster is being created in this run — skips cluster-VPC-derived data sources that require a pre-existing clusterno
cluster_vpc_idstring""ID of the cluster VPC — pass module.roks_cluster.roks_cluster_vpc_id directly; avoids deriving via worker-pool subnet chain which is deferred to apply timeno
cluster_absentboolfalseTrue only in the standalone FLP-VSI phase: no ROKS cluster exists, so cluster data-source lookups are skipped (count=0).no
testing_jumphost_allowed_cidrslist(string)[]Source CIDRs allowed to SSH (:22) to the testing jumphosts. Empty → 0.0.0.0/0 (open — the jumphosts carry a public floating IP and are reached from wherever the operator happens to be; access is key-only). Narrow this to the operator’s public /32 on a shared account.no
testing_client_vpc_inbound_cidrslist(string)[]Source CIDRs allowed inbound to the testing client VPC’s DEFAULT security group. Empty → the RFC-1918 private ranges, which is where in-fabric test traffic arrives from (the cluster reaches the client VPC over the Transit Gateway). Set explicitly only if a test needs a public source.no

Module: tgw_connection

Source: terraform/modules/tgw_connection/variables.tf

VariableTypeDefaultDescriptionSensitive
deploy_tgw_connectionboolfalseAttach the cluster’s VPC to an existing Transit Gateway. Off in every other phase’s override; on only for tgw connect. When false the module is a complete no-op.no
ibmcloud_api_keystring""IBM Cloud API key (IAM auth + provider config).yes
ibmcloud_cluster_regionstring""Region of the cluster VPC (ibm provider + the ibm_is_vpc lookup).no
cluster_vpc_idstring""ID of the cluster’s VPC — the network attached to the Transit Gateway. Resolved to a CRN here; the connection needs the CRN, but cluster-outputs.json records the id.no
transit_gatewaystring""The EXISTING Transit Gateway to attach to, by NAME or by ID. Resolved against the account’s gateway list, so either works. Multiple clusters passing the same value share one gateway; each workspace owns its own connection.no
connection_namestring""Name for THIS cluster’s connection on the gateway. Must be unique per gateway, so it is prefix-derived — two clusters sharing one Transit Gateway get distinct connection names.no