roksbnkctl config.yaml cheatsheet v1.64.0

Every field the workspace schema accepts, with the dotted path you actually type and the ROKSBNKCTL_* override that sets it. Generated from internal/config/workspace.go — 188 fields, 162 reachable by an environment override.

Two ways to set the same thing. A field can come from config.yaml or from its ROKSBNKCTL_* variable; the environment wins. roksbnkctl config yaml and roksbnkctl config env print either form, and --from-yaml / --from-env convert between them.
Path Type Req Line Default Env override Description
agent  Agent configures `roksbnkctl agent`, which hands the workspace to a coding agent.
agent.defaultstring—both——Default is the agentic CLI `roksbnkctl agent` (no arg) reports as this workspace's default — claude | gemini | aider | openai | pi | opencode.
agent.llm_endpointstring—both——LLMEndpoint is an optional OpenAI-/Anthropic-compatible base URL woven into the printed invocation (cloud vendor, local vLLM, etc.).
bnk  BNK configures the BIG-IP Next for Kubernetes install itself: the manifest version (which also decides whether the 2.3 or 2.4 model is rendered), licensing, the per-zone network mapping, and the CNEInstance settings that place the TMM pods.
bnk.advancedmap[string]AdvancedComponentCfg—both——Advanced carries per-component environment passthrough for the 2.4 CNEInstance's advanced.<component>.env[] lists (#175).
bnk.cert_manager.namespacestring—both—ROKSBNKCTL_CERT_MANAGER_NAMESPACENamespace cert-manager installs into (rendered as cert_manager_namespace).
bnk.cert_manager.versionstring—both—ROKSBNKCTL_CERT_MANAGER_VERSIONVersion pins the cert-manager Helm chart (rendered as cert_manager_version).
bnk.cis.bigip_password_b64string—both—ROKSBNKCTL_BIGIP_PASSWORDBigIPPasswordB64 is that account's password, base64-encoded — obfuscation, not encryption.
bnk.cis.bigip_urlstring—both—ROKSBNKCTL_BIGIP_URLBigIPURL is the management address of the classic BIG-IP that the Container Ingress Services controller configures, e.g. "https://10.1.1.5".
bnk.cis.bigip_usernamestring—both—ROKSBNKCTL_BIGIP_USERNAMEBigIPUsername is the account CIS authenticates to that BIG-IP as.
bnk.cluster_identifierstring—2.4—ROKSBNKCTL_CLUSTER_IDENTIFIERClusterIdentifier is passed to the external BIG-IP controller.
bnk.cneinstance_sizestring—both—ROKSBNKCTL_CNEINSTANCE_SIZECNEInstanceSize is the CNEInstance deploymentSize: Tiny, Small, Medium, Large or Max.
bnk.demo_mode*bool—bothfalse on 2.4, true on 2.3ROKSBNKCTL_DEMO_MODEDemoMode sets advanced.demoMode.enabled.
bnk.external_bigip*bool—2.4falseROKSBNKCTL_EXTERNAL_BIGIPExternalBigIP enables the external BIG-IP controller.
bnk.external_bigip_login_secretstring—2.4f5-bigip-ctlr-loginROKSBNKCTL_EXTERNAL_BIGIP_LOGIN_SECRETExternalBigIPLoginSecret holds the external BIG-IP credentials.
bnk.far_auth_filestring—both—ROKSBNKCTL_FAR_AUTH_FILEFarAuthFile is the FAR auth tarball's filename in the orchestration COS bucket; rendered as the f5_cne_far_auth_file tfvar + used by `registry` to resolve the FAR _json_key_base64 service account.
bnk.far_auth_local_filestring—both—ROKSBNKCTL_FAR_AUTH_LOCAL_FILEFarAuthLocalFile / SubscriptionJWTLocalFile point at LOCAL files instead of COS objects.
bnk.far_repo_urlstring—bothrepo.f5.comROKSBNKCTL_FAR_REPO_URLFARRepoURL is the F5 Artifact Repository charts are pulled from.
bnk.flo_namespacestring—bothf5-bnkROKSBNKCTL_FLO_NAMESPACEFLONamespace / FLOUtilsNamespace override the namespaces the F5 Lifecycle Operator and its utility components install into (rendered as flo_namespace / flo_utils_namespace).
bnk.flo_utils_namespacestring—bothf5-utilsROKSBNKCTL_FLO_UTILS_NAMESPACEFLOUtilsNamespace is where FLO's SHARED utility components install — coremond, the observer, the licence — as opposed to FLONamespace, which holds the BNK instance itself.
bnk.flp.chart_versionstring—both—ROKSBNKCTL_FLP_CHART_VERSIONChartVersion pins the f5-license-proxy chart.
bnk.flp.external.root_ca_b64string—both—ROKSBNKCTL_FLP_ROOT_CA_B64RootCAB64 is the proxy's root CA, base64-encoded (as `flp output` emits it).
bnk.flp.external.urlstring—both—ROKSBNKCTL_FLP_EXTERNAL_URLURL of the proxy, e.g. https://10.240.64.5:30001 — reachable from THIS cluster's pods.
bnk.flp.modestring—both—ROKSBNKCTL_FLP_MODEMode selects HOW the FLP phase deploys the proxy: "" | "helm" → the f5-license-proxy Helm chart into the ROKS cluster (default).
bnk.flp.namespacestring—both—ROKSBNKCTL_FLP_NAMESPACENamespace the FLP is installed into (helm mode).
bnk.flp.node_port_accessbool—both—ROKSBNKCTL_FLP_NODE_PORT_ACCESSNodePortAccess exposes the proxy OUTSIDE its own cluster, so a BNK install in a DIFFERENT cluster (same VPC, or across a transit gateway) can license through it — the "shared licensing cluster" topology, where only the cluster running the proxy needs egress to F5.
bnk.flp.node_port_source_cidrs[]string—both—ROKSBNKCTL_FLP_NODE_PORT_SOURCE_CIDRSNodePortSourceCIDRs, when set with NodePortAccess, opens the proxy's NodePort on the cluster's worker security group to these CIDRs — the consuming cluster's subnets.
bnk.flp.storage_classstring—both—ROKSBNKCTL_FLP_STORAGE_CLASSStorageClass is the dynamic StorageClass for the FLP's PVCs (rendered as flp_storage_class).
bnk.flp.vsi.allowed_cidrs[]string—both—ROKSBNKCTL_FLP_VSI_ALLOWED_CIDRSAllowedCIDRs is DEPRECATED — a legacy single list.
bnk.flp.vsi.boot_size_gbint—both—ROKSBNKCTL_FLP_VSI_BOOT_SIZE_GBBootSizeGB is the boot volume size.
bnk.flp.vsi.create_vpcbool—both—ROKSBNKCTL_FLP_VSI_CREATE_VPCCreateVPC builds the proxy its OWN VPC, address prefix and public gateway rather than placing it in one that already exists (#60).
bnk.flp.vsi.floating_ip*bool—both—ROKSBNKCTL_FLP_VSI_FLOATING_IPFloatingIP attaches an operator floating IP to the FLP VSI for remote management — running `roksbnkctl flp status` and reaching the :80 web UI + the :8443 proxy from a machine OUTSIDE the VPC.
bnk.flp.vsi.forward_proxy.hoststring—both—ROKSBNKCTL_FLP_VSI_FORWARD_PROXY_HOSTHost is the forward proxy's address.
bnk.flp.vsi.forward_proxy.portint—both—ROKSBNKCTL_FLP_VSI_FORWARD_PROXY_PORTPort is the forward proxy's port.
bnk.flp.vsi.forward_proxy.protocolstring—both—ROKSBNKCTL_FLP_VSI_FORWARD_PROXY_PROTOCOLhttp (default) | https
bnk.flp.vsi.licensing_allowed_cidrs[]string—both—ROKSBNKCTL_FLP_VSI_LICENSING_ALLOWED_CIDRSLicensingAllowedCIDRs are the source CIDRs permitted to reach the :8443 licensing proxy (and :22 SSH).
bnk.flp.vsi.management_allowed_cidrs[]string—both—ROKSBNKCTL_FLP_VSI_MANAGEMENT_ALLOWED_CIDRSManagementAllowedCIDRs are the source CIDRs permitted to reach the :80 flp-status web UI (read-only status).
bnk.flp.vsi.name_prefixstring—both—ROKSBNKCTL_FLP_VSI_NAME_PREFIXNamePrefix prefixes the FLP VSI's IBM Cloud resource names — instance, subnet, security group, floating IP, public gateway, boot volume, and the VPC when this module creates one.
bnk.flp.vsi.profilestring—both—ROKSBNKCTL_FLP_VSI_PROFILEProfile is the IBM Cloud VSI instance profile.
bnk.flp.vsi.ssh_keystring—both—ROKSBNKCTL_FLP_VSI_SSH_KEYSSHKey is the name of an existing IBM Cloud VPC SSH key (RSA) to attach to the FLP VSI, so an operator can SSH in to inspect/recover the licensing appliance (podman pod, Vault, logs).
bnk.flp.vsi.status_imagestring—both—ROKSBNKCTL_FLP_VSI_STATUS_IMAGEStatusImage, when set, runs the flp-status web UI as a container in the FLP pod (mobile-friendly status page + /api/status + live logs on :80, no auth — a read-only private status endpoint).
bnk.flp.vsi.status_registry_ca_b64string—both—ROKSBNKCTL_FLP_VSI_STATUS_REGISTRY_CA_B64StatusRegistryCAB64 is that registry's CA, base64-encoded, written to /etc/containers/certs.d/<host>/ca.crt on the VSI.
bnk.flp.vsi.status_registry_hoststring—both—ROKSBNKCTL_FLP_VSI_STATUS_REGISTRY_HOSTStatusRegistryHost + StatusRegistryCAB64 make the VSI trust a self-signed mirror so it can pull StatusImage: cloud-init drops the (base64) CA into /etc/containers/certs.d/<host>/ca.crt before the pod comes up.
bnk.flp.vsi.subnet_cidrstring—both—ROKSBNKCTL_FLP_VSI_SUBNET_CIDRSubnetCIDR is the address prefix for that VPC.
bnk.flp.vsi.vpcstring—both—ROKSBNKCTL_FLP_VSI_VPCVPC is an existing VPC id to deploy the standalone FLP VSI into, WITHOUT any ROKS cluster.
bnk.flp.vsi.vpc_namestring—both—ROKSBNKCTL_FLP_VSI_VPC_NAMEVPCName names the VPC created when CreateVPC is set.
bnk.flp.vsi.zonestring—both—ROKSBNKCTL_FLP_VSI_ZONEZone the VSI lands in (e.g. us-south-1).
bnk.gateway_api_bundle_urlstring—2.4—ROKSBNKCTL_GATEWAY_API_BUNDLE_URLGatewayAPIBundleURL is where the Gateway API standard-install bundle is FETCHED from when `gateway_api_mtls` is on (#185).
bnk.gateway_api_mtlsbool—2.4—ROKSBNKCTL_GATEWAY_API_MTLSGatewayAPIMTLS opts into the Gateway API bundle BNK 2.4 needs for mTLS (#170).
bnk.gateway_api_versionstring—2.41.5.0ROKSBNKCTL_GATEWAY_API_VERSIONGatewayAPIVersion is GATEWAY_API_VERSION for the CNE controller.
bnk.gslb_datacenter_namestring—both—ROKSBNKCTL_GSLB_DATACENTER_NAMEGSLBDatacenterName sets the optional CNEInstance GSLB datacenter name (rendered as cneinstance_gslb_datacenter_name).
bnk.hugepages.countint—both2048ROKSBNKCTL_HUGEPAGES_COUNTCount is the number of pages PER NODE.
bnk.hugepages.enabledbool—both—ROKSBNKCTL_HUGEPAGESEnabled allocates hugepages.
bnk.hugepages.node_rolestring—bothworkerROKSBNKCTL_HUGEPAGES_NODE_ROLENodeRole is the machineconfiguration.openshift.io/role the profile applies to.
bnk.hugepages.profile_namestring—bothbnk-hugepagesROKSBNKCTL_HUGEPAGES_PROFILE_NAMEProfileName names the Tuned profile and CR.
bnk.hugepages.sizestring—both2MROKSBNKCTL_HUGEPAGES_SIZESize is the hugepage size, e.g. "2M" or "1G".
bnk.license_modestring—bothconnectedROKSBNKCTL_LICENSE_MODELicenseMode selects the License CR operationMode: "connected" (default when empty), "disconnected", or "f5licenseproxy".
bnk.manifest_versionstring—both—ROKSBNKCTL_MANIFEST_VERSIONManifestVersion pins the BNK release, e.g. "2.4.0-EA".
bnk.network.tmm_k8s_routesstring—both172.17.0.0/18ROKSBNKCTL_TMM_K8S_ROUTESTMMK8SRoutes is the Kubernetes pod CIDR TMM installs a route toward (advanced.tmm.env TMM_K8S_ROUTES), so TMM can reach backend pods on the internal data path.
bnk.network.vlan_prefixlen*int—2.324ROKSBNKCTL_VLAN_PREFIXLENVLANPrefixLen is the self-IP prefix length (spec.prefixlen_v4) TMM applies to its external and internal self-IPs on the F5SPKVlan CRs — the size of the L2 subnet TMM treats as directly connected on each VLAN.
bnk.network.vlan_prefixlen_external*int—2.3—ROKSBNKCTL_VLAN_PREFIXLEN_EXTERNALVLANPrefixLenExternal / VLANPrefixLenInternal override VLANPrefixLen for one VLAN.
bnk.network.vlan_prefixlen_internal*int—2.3—ROKSBNKCTL_VLAN_PREFIXLEN_INTERNALVLANPrefixLenInternal is the same override for the INTERNAL VLAN.
bnk.network.zones[]BNKZoneCfg—both——Zones is the per-availability-zone network mapping, in zone order — one entry per zone the cluster spans.
bnk.network.zones[].ext_vlan_cidrstring—both—ROKSBNKCTL_ZONE1_EXT_VLAN_CIDR / ROKSBNKCTL_ZONE2_EXT_VLAN_CIDR / ROKSBNKCTL_ZONE3_EXT_VLAN_CIDRExtVLANCIDR is the zone's EXTERNAL VLAN — the client side of the data plane, where traffic arrives.
bnk.network.zones[].external_selfipstring—2.3—ROKSBNKCTL_ZONE1_EXTERNAL_SELFIP / ROKSBNKCTL_ZONE2_EXTERNAL_SELFIP / ROKSBNKCTL_ZONE3_EXTERNAL_SELFIPExternalSelfIP is TMM's own address on the external VLAN.
bnk.network.zones[].int_snat_cidrstring—both—ROKSBNKCTL_ZONE1_INT_SNAT_CIDR / ROKSBNKCTL_ZONE2_INT_SNAT_CIDR / ROKSBNKCTL_ZONE3_INT_SNAT_CIDRIntSNATCIDR is the pool BNK source-NATs to when it talks to pods, so the return traffic comes back through TMM rather than routing around it.
bnk.network.zones[].int_vip_cidrstring—both—ROKSBNKCTL_ZONE1_INT_VIP_CIDR / ROKSBNKCTL_ZONE2_INT_VIP_CIDR / ROKSBNKCTL_ZONE3_INT_VIP_CIDRIntVIPCIDR is the range virtual servers are allocated from on the internal side.
bnk.network.zones[].int_vlan_cidrstring—2.3—ROKSBNKCTL_ZONE1_INT_VLAN_CIDR / ROKSBNKCTL_ZONE2_INT_VLAN_CIDR / ROKSBNKCTL_ZONE3_INT_VLAN_CIDRIntVLANCIDR is the zone's INTERNAL VLAN — the pod side, where BNK reaches the workloads it fronts.
bnk.network.zones[].internal_selfipstring—2.3—ROKSBNKCTL_ZONE1_INTERNAL_SELFIP / ROKSBNKCTL_ZONE2_INTERNAL_SELFIP / ROKSBNKCTL_ZONE3_INTERNAL_SELFIPInternalSelfIP is TMM's own address on the internal VLAN.
bnk.preflight.reachability_retry_seconds*int—both—ROKSBNKCTL_REACHABILITY_RETRY_SECONDSReachabilityRetrySeconds is how long a target may keep failing before the verdict is believed.
bnk.preflight.reachability_timeout_seconds*int—both—ROKSBNKCTL_REACHABILITY_TIMEOUT_SECONDSReachabilityTimeoutSeconds is how long to wait for the probe DaemonSet to report from every node.
bnk.storage_class_namestring—both—ROKSBNKCTL_STORAGE_CLASS_NAMEStorageClassName is the StorageClass the CNEInstance's persistent volumes use, TMM's included.
bnk.subscription_jwt_filestring—both—ROKSBNKCTL_SUBSCRIPTION_JWT_FILESubscriptionJWTFile is the subscription/license JWT's filename in the orchestration COS bucket; rendered as the f5_cne_subscription_jwt_file tfvar.
bnk.subscription_jwt_local_filestring—both—ROKSBNKCTL_SUBSCRIPTION_JWT_LOCAL_FILESubscriptionJWTLocalFile is the F5 subscription JWT as a LOCAL file, the companion to FarAuthLocalFile above.
bnk.tcp_settingsmap[string]string—both——TCPSettings overrides individual fields on the data-plane F5BigTcpSetting CR by name, e.g. {"congestionControl": "bbr", "delayedAcks": "true"} — the key is the CR's own spec field.
bnk.tcp_settings_namestring—bothsys-default-tcpROKSBNKCTL_TCP_SETTINGS_NAMETCPSettingsName is the F5BigTcpSetting to write.
bnk.tmm_anti_affinity*bool—2.4trueROKSBNKCTL_TMM_ANTI_AFFINITYTMMAntiAffinity requires f5-tmm pods onto different nodes.
bnk.tmm_anti_affinity_topology_keystring—2.4kubernetes.io/hostnameROKSBNKCTL_TMM_ANTI_AFFINITY_TOPOLOGY_KEYTMMAntiAffinityTopologyKey is the node label the anti-affinity rule spreads across — the IBM ROKS per-node label.
bnk.tmm_pod_labelstring—2.4f5-tmmROKSBNKCTL_TMM_POD_LABELTMMPodLabel is the `app` label value the placement rules select TMM by.
bnk.tmm_replicasint—2.43ROKSBNKCTL_TMM_REPLICASTMMReplicas is the number of f5-tmm data-plane replicas.
bnk.tmm_resourcesmap[string]map[string]string—both——TMMResources overrides the TMM pod's resource requests/limits, rendered as the CNEInstance's advanced.tmm.resources (#203).
bnk.tmm_rolling_update*bool—2.4trueROKSBNKCTL_TMM_ROLLING_UPDATETMMRollingUpdate pins TMM's rolling update to maxSurge 0 / maxUnavailable 1 — the same shape as the cwc Multi-Attach deadlock, where an unconstrained rolling update on a single-attach resource wedges.
bnk.tmm_zone_max_skewint—2.41ROKSBNKCTL_TMM_ZONE_MAX_SKEWTMMZoneMaxSkew is maxSkew for the zone topology-spread constraint.
bnk.tmm_zone_spread*bool—2.4trueROKSBNKCTL_TMM_ZONE_SPREADTMMZoneSpread spreads f5-tmm pods across zones.
bnk.tmm_zone_topology_keystring—2.4topology.kubernetes.io/zoneROKSBNKCTL_TMM_ZONE_TOPOLOGY_KEYTMMZoneTopologyKey is the IBM ROKS zone label the spread constraint uses.
bnk.tmm_zone_when_unsatisfiablestring—2.4DoNotScheduleROKSBNKCTL_TMM_ZONE_WHEN_UNSATISFIABLETMMZoneWhenUnsatisfiable is DoNotSchedule or ScheduleAnyway.
bnk.trusted_profile.roles[]string—both[Viewer, Editor]ROKSBNKCTL_TRUSTED_PROFILE_ROLESRoles granted to the profile, scoped to the cluster's OWN VPC.
bnk.trusted_profile.service_accountstring—both—ROKSBNKCTL_TRUSTED_PROFILE_SAServiceAccount is the Kubernetes service account the profile is LINKED to: which account may assume it.
bnk.watch_namespaces[]string—2.4AllROKSBNKCTL_WATCH_NAMESPACESWatchNamespaces are the namespaces the CNE controller watches.
bnk.whole_cluster*bool—bothfalse on 2.4, true on 2.3ROKSBNKCTL_WHOLE_CLUSTERTCPSettings overrides fields on the data-plane F5BigTcpSetting CR.
bnkforge  BNKForge points at a BNK Forge server, which takes over a durable cluster once roksbnkctl has built it.
bnkforge.ca_b64string—both—ROKSBNKCTL_BNKFORGE_CA_B64CAB64 pins the CA the Forge server's certificate must chain to, PEM, base64-encoded.
bnkforge.insecurebool—both—ROKSBNKCTL_BNKFORGE_INSECUREInsecure skips TLS verification against the Forge server.
bnkforge.password_b64string—both—ROKSBNKCTL_BNKFORGE_PASSWORDPasswordB64 is that user's password, base64-encoded — obfuscation, NOT encryption, exactly as bnk.cis.bigip_password_b64 and registry.generic_password_b64 are.
bnkforge.projectstring—both—ROKSBNKCTL_BNKFORGE_PROJECTProject is the target BNK Forge project NAME.
bnkforge.registerbool—both—ROKSBNKCTL_BNKFORGE_REGISTERRegister opts the workspace in.
bnkforge.urlstring—both—ROKSBNKCTL_BNKFORGE_URLURL is the BNK Forge server base URL (e.g. https://forge.example.com).
bnkforge.usernamestring—both—ROKSBNKCTL_BNKFORGE_USERNAMEUsername is the BNK Forge login user.
cluster  Cluster describes the ROKS cluster — either one to CREATE, or one that already exists and is being adopted (`create: false` plus its name).
cluster.createbool—both—ROKSBNKCTL_CLUSTER_CREATECreate decides whether this workspace BUILDS the ROKS cluster or adopts one that already exists.
cluster.existing_subnet_ids[]string—both—ROKSBNKCTL_EXISTING_SUBNET_IDSExistingSubnetIDs places the cluster in subnets that ALREADY EXIST, one per zone in zone order, instead of creating them (#61).
cluster.min_worker_memory_gbint—both64ROKSBNKCTL_MIN_WORKER_MEMORY_GBMinWorkerMemoryGB is the memory floor for the same auto-select.
cluster.min_worker_vcpu_countint—both16ROKSBNKCTL_MIN_WORKER_VCPU_COUNTMinWorkerVCPUCount is the vCPU floor for the worker-flavor auto-select: the cluster module picks the smallest bx2 profile meeting this and MinWorkerMemoryGB.
cluster.namestring—both—ROKSBNKCTL_CLUSTER_NAMEName is the ROKS cluster's name — the one to create, or the existing one to adopt when Create is false.
cluster.network_modestring—bothsingle-nicROKSBNKCTL_CLUSTER_NETWORK_MODENetworkMode selects how the cluster's worker nodes are attached: "single-nic" (the default, and today's only behaviour) or "multi-nic".
cluster.openshift_versionstring—both—ROKSBNKCTL_OPENSHIFT_VERSIONOpenShiftVersion pins the OpenShift version for a CREATED cluster (e.g. "4.20").
cluster.public_gateway*bool—bothtrueROKSBNKCTL_CLUSTER_PUBLIC_GATEWAYPublicGateway controls whether the cluster subnets attach a public gateway for worker Internet egress.
cluster.vpc_cidrstring—both—ROKSBNKCTL_CLUSTER_VPC_CIDRVPCCIDR is the block the cluster VPC's per-zone address prefixes are carved from — "10.241.0.0/16" becomes 10.241.0.0/18, 10.241.64.0/18, 10.241.128.0/18.
cluster.worker_flavorstring—both—ROKSBNKCTL_WORKER_FLAVORWorkerFlavor names the worker profile EXACTLY, e.g. "cx3d.8x20".
cluster.workers_per_zoneint—both1ROKSBNKCTL_WORKERS_PER_ZONEWorkersPerZone is the worker count PER ZONE, not in total: ROKS spans three availability zones, so 2 here is a six-node cluster.
cos  COS is the IBM Cloud Object Storage bucket the FAR service-account credential is read from, for estates that stage it there rather than passing a local file.
cos.bucketstring—bothbnk-artifactsROKSBNKCTL_COS_BUCKETBucket is the bucket the FAR service-account credential is read from, for estates that stage it centrally rather than passing a local file.
cos.instancestring—bothbnk-supply-chainROKSBNKCTL_COS_INSTANCEInstance is the IBM Cloud Object Storage service instance holding the bucket.
cos.regionstring—bothus-southROKSBNKCTL_COS_REGIONRegion is the bucket's region, which need not match ibmcloud.region.
cos.resource_groupstring—both——ResourceGroup is the IBM Cloud resource group holding Instance.
cos.upload[]COSUpload—both——Upload lists local files to place into that bucket before the phases that read them run.
cos.upload[].keystring—both——Key is the object name it is stored under in the bucket.
cos.upload[].sourcestring—both——Source is the local file to upload.
exec  Exec is the per-tool execution-backend config block introduced in Sprint 3 (PRD 03).
execmap[string]ExecToolCfg—both——Exec is the per-tool execution-backend config block introduced in Sprint 3 (PRD 03).
gateway  Gateway configures the Gateway API resources installed after BNK.
gateway.app_namespacestring—bothf5-appROKSBNKCTL_GATEWAY_APP_NAMESPACEAppNamespace is the namespace the example application and its Gateway resources are created in.
gateway.backend_portint—both80ROKSBNKCTL_GATEWAY_BACKEND_PORTBackendPort is the port on that Service.
gateway.backend_servicestring—bothnginx-serviceROKSBNKCTL_GATEWAY_BACKEND_SERVICEBackendService is the Kubernetes Service the example HTTPRoute forwards to.
gateway.class_namestring—bothgateway-classROKSBNKCTL_GATEWAY_CLASS_NAMEClassName is the GatewayClass name.
gateway.client_subnet_local[]string—both—ROKSBNKCTL_GATEWAY_CLIENT_SUBNET_LOCALClientSubnetLocal lists client CIDRs reachable on the same VPC as the cluster — routed directly rather than over the transit gateway.
gateway.client_subnet_remote[]string—both—ROKSBNKCTL_GATEWAY_CLIENT_SUBNET_REMOTEClientSubnetRemote lists client CIDRs reached ACROSS the transit gateway, e.g. the testing client VPC.
gateway.controller_namestring—both—ROKSBNKCTL_GATEWAY_CONTROLLER_NAMEControllerName is the GatewayClass controllerName.
gateway.egress_modestring—bothsnatpoolROKSBNKCTL_GATEWAY_EGRESS_MODEEgressMode selects how return traffic is source-addressed: "snatpool", "automap", or "both".
gateway.l4_listener_portint—both8080ROKSBNKCTL_GATEWAY_L4_LISTENER_PORTL4ListenerPort is the port for that TCP listener.
gateway.route_examples[]string—both—ROKSBNKCTL_GATEWAY_ROUTE_EXAMPLESRouteExamples names extra route kinds to create WORKING examples of, alongside the HTTPRoute the gateway phase already creates.
gateway.vxlan_portint—both6789ROKSBNKCTL_GATEWAY_VXLAN_PORTVXLANPort is the UDP port for the VXLAN overlay between TMM and the nodes.
ibmcloud  IBMCloud is the account context every phase runs against: region, resource group, and the API key (base64-obfuscated, never plaintext).
ibmcloud.api_key_b64string—both—IBMCLOUD_API_KEY / ROKSBNKCTL_API_KEY_B64APIKeyB64 stores the API key base64-encoded inline in the workspace config.
ibmcloud.api_key_sourcestring—both—ROKSBNKCTL_API_KEY_SOURCEenv | keychain | config | prompt — see secrets.go
ibmcloud.regionstringyesboth—ROKSBNKCTL_REGIONRegion is the IBM Cloud region everything in this workspace is created in or adopted from, e.g. "us-east".
ibmcloud.resource_groupstringyesbothdefaultROKSBNKCTL_RESOURCE_GROUPResourceGroup is the IBM Cloud resource group resources are placed in, and the one an adopted cluster is looked up in.
prefix  Prefix is the workspace's account-scoped resource-name base.
prefixstringyesboth—ROKSBNKCTL_PREFIXPrefix is the workspace's account-scoped resource-name base.
registry  Registry selects where images and charts are pulled from: F5's Artifact Repository directly, or a mirror that a disconnected cluster can reach — IBM Container Registry, or any OCI registry (`generic`) such as Artifactory or Harbor.
registry.generic_ca_b64string—both—ROKSBNKCTL_GENERIC_CA_B64GenericCAB64 is the mirror's CA chain, PEM, base64-encoded — the AUTHORITATIVE copy, recorded from the file that generated it rather than learned from the network.
registry.generic_ca_sha256string—both—ROKSBNKCTL_GENERIC_CA_SHA256GenericCASHA256 pins the mirror's CA by SHA-256 (hex; a "sha256:" prefix and colons are accepted).
registry.generic_hoststring—both—ROKSBNKCTL_GENERIC_HOSTGenericHost is the OCI registry host for target=generic (e.g. "artifactory.example.com").
registry.generic_password_b64string—both—ROKSBNKCTL_GENERIC_PASSWORDGenericPasswordB64 is that user's password or access token, base64-encoded — obfuscation, not encryption.
registry.generic_repo_prefixstring—both—ROKSBNKCTL_GENERIC_REPO_PREFIXGenericRepoPrefix is the repository path artifacts nest under for target=generic (e.g. an Artifactory repo key).
registry.generic_usernamestring—both—ROKSBNKCTL_GENERIC_USERNAMEGenericUsername / GenericPasswordB64 are the static basic-auth credential for target=generic (an Artifactory user + access token).
registry.icr_hoststring—both—ROKSBNKCTL_ICR_HOSTICRHost overrides the IBM Container Registry host for target=icr (e.g. "de.icr.io").
registry.icr_namespacestring—both—ROKSBNKCTL_ICR_NAMESPACEICRNamespace is the ICR namespace artifacts nest under for target=icr.
registry.include_deps*bool—both—ROKSBNKCTL_REGISTRY_INCLUDE_DEPSIncludeDeps unions the non-F5 dependency artifacts (Jetstack cert-manager chart + images, the registry.k8s.io/kubectl node-labeler image) into the BOM.
registry.namespacestring—both—ROKSBNKCTL_REGISTRY_NAMESPACENamespace is the mirror project the artifacts land in.
registry.source_service_account_b64string—both—ROKSBNKCTL_SOURCE_SERVICE_ACCOUNT_B64SourceServiceAccountB64 is the FAR `_json_key_base64` service-account JSON, base64-encoded, used as the replication SOURCE credential for repo.f5.com.
registry.targetstring—both—ROKSBNKCTL_REGISTRY_TARGETTarget selects the mirror backend: "icr" (IBM Container Registry — the DEFAULT when unset) or "generic" (any OCI-compliant registry — Artifactory / Harbor / Quay / registry:2).
resources  Resources carries the per-resource create toggles (and the existing-resource name/ID for any declined-but-still-depended-on resource).
resources.bnk.createbool—both—ROKSBNKCTL_BNK_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.bnk.existingstring—both—ROKSBNKCTL_BNK_EXISTINGExisting is the name or ID of the resource to adopt when Create is false.
resources.cert_manager.createbool—both—ROKSBNKCTL_CERT_MANAGER_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.cert_manager.existingstring—both—ROKSBNKCTL_CERT_MANAGER_EXISTINGExisting is the name or ID of the resource to adopt when Create is false.
resources.client_regionstring—both—ROKSBNKCTL_CLIENT_REGIONClientRegion is the region the testing client (TGW jumphost + client VPC) is installed in.
resources.client_vpc.createbool—both—ROKSBNKCTL_CLIENT_VPC_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.client_vpc.existingstring—both—ROKSBNKCTL_CLIENT_VPC_NAMEExisting is the name or ID of the resource to adopt when Create is false.
resources.cluster_http_allowed_cidrs[]string—both—ROKSBNKCTL_CLUSTER_HTTP_ALLOWED_CIDRSClusterHTTPAllowedCIDRs gates :80 on the cluster security group — the ingress/ALB path, which is meant to be publicly reachable, so empty means open.
resources.cluster_jumphosts.createbool—both—ROKSBNKCTL_CLUSTER_JUMPHOSTS_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.cluster_jumphosts.existingstring—both—ROKSBNKCTL_CLUSTER_JUMPHOSTS_EXISTINGExisting is the name or ID of the resource to adopt when Create is false.
resources.cluster_vpc.createbool—both—ROKSBNKCTL_CLUSTER_VPC_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.cluster_vpc.existingstring—both—ROKSBNKCTL_CLUSTER_VPC_IDExisting is the name or ID of the resource to adopt when Create is false.
resources.cluster_vpc_default_sg_inbound_cidrs[]string—both—ROKSBNKCTL_CLUSTER_VPC_DEFAULT_SG_INBOUND_CIDRSClusterVPCDefaultSGInboundCIDRs gates the cluster VPC's DEFAULT security group, which the cluster phase widens to all protocols and ports.
resources.copied_ssh_key_files[]string—both—ROKSBNKCTL_COPIED_SSH_KEY_FILESCopiedSSHKeyFiles lists the ~/.ssh basenames `roksbnkctl init` ACTUALLY wrote when the user accepted the "copy the private key to ~/.ssh" prompt (only files it created — pre-existing files are skipped, never recorded).
resources.registry_cos.createbool—both—ROKSBNKCTL_REGISTRY_COS_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.registry_cos.existingstring—both—ROKSBNKCTL_REGISTRY_COS_EXISTINGExisting is the name or ID of the resource to adopt when Create is false.
resources.testing_client_vpc_inbound_cidrs[]string—both—ROKSBNKCTL_TESTING_CLIENT_VPC_INBOUND_CIDRSTestingClientVPCInboundCIDRs gates the client VPC's DEFAULT security group, which the testing phase widens to all protocols and ports.
resources.testing_client_vpc_namestring—bothtf-testing-vpcROKSBNKCTL_TESTING_VPC_NAMETestingClientVPCName names the testing client VPC when ClientVPC.Create is true (rendered as testing_client_vpc_name).
resources.testing_jumphost_allowed_cidrs[]string—both—ROKSBNKCTL_TESTING_JUMPHOST_ALLOWED_CIDRSSecurity-group source CIDRs, following the flp_vsi module's split between a management plane and an in-fabric plane.
resources.testing_jumphost_profilestring—both—ROKSBNKCTL_TESTING_JUMPHOST_PROFILEJumphost sizing.
resources.testing_min_memory_gbint—both8ROKSBNKCTL_TESTING_MIN_MEMORY_GBTestingMinMemoryGB is the memory floor for the same auto-select.
resources.testing_min_vcpu_countint—both4ROKSBNKCTL_TESTING_MIN_VCPU_COUNTTestingMinVCPUCount is the vCPU floor for the jumphost auto-select.
resources.testing_ssh_key_namestring—both—ROKSBNKCTL_TESTING_SSH_KEY_NAMETestingSSHKeyName is the IBM Cloud VPC SSH key name attached to the testing jumphosts (rendered as testing_ssh_key_name).
resources.tgw_jumphost.createbool—both—ROKSBNKCTL_TGW_JUMPHOST_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.tgw_jumphost.existingstring—both—ROKSBNKCTL_TGW_JUMPHOST_EXISTINGExisting is the name or ID of the resource to adopt when Create is false.
resources.transit_gateway.createbool—both—ROKSBNKCTL_TRANSIT_GATEWAY_CREATECreate decides whether roksbnkctl provisions this resource or adopts one that already exists.
resources.transit_gateway.existingstring—both—ROKSBNKCTL_TRANSIT_GATEWAY_NAMEExisting is the name or ID of the resource to adopt when Create is false.
state  State controls where Terraform state is kept and how it is locked.
state.backendstring—both——"" | "local" | "s3"
state.s3.access_key_sourcestring—both——env var name; default ROKSBNKCTL_COS_HMAC_ACCESS_KEY
state.s3.bucketstring—both——pre-provisioned bucket
state.s3.endpointstring—both——COS S3 endpoint URL
state.s3.key_prefixstring—both——default: the workspace name
state.s3.regionstring—both——COS location / region
state.s3.secret_key_sourcestring—both——env var name; default ROKSBNKCTL_COS_HMAC_SECRET_KEY
targets  Targets are named remote hosts (`ssh:<target>`) that Exec backends can run tools on — a jumphost inside the VPC, say, when the operator's workstation cannot reach the cluster directly.
targetsmap[string]TargetCfg—both——Targets are named remote hosts (`ssh:<target>`) that Exec backends can run tools on — a jumphost inside the VPC, say, when the operator's workstation cannot reach the cluster directly.
test  Test configures the connectivity, DNS and throughput probes `roksbnkctl test` runs, and the jumphost they run FROM.
test.connectivity.extra_hosts[]string—both——ExtraHosts are additional targets the connectivity probe tries, beyond the defaults.
test.dns.default_targetstring—both——DefaultTarget is the resolver queried when a probe names none.
test.dns.resolversmap[string]string—both——Resolvers names the DNS servers to query, as name → "<ip>[:<port>]".
test.throughput.default_modestring—bothnorth-south—north-south | east-west
test.throughput.durationint—both30—seconds; default 30
test.throughput.imagestring—bothnetworkstatic/iperf3:latest—default: networkstatic/iperf3:latest
test.throughput.streamsint—both8—parallel; default 8
tf_source  TFSource selects which Terraform the binary applies: the `embedded` tree shipped inside this binary (the default, and the only version matched to it), a GitHub release, or a local path for testing a fork.
tf_source.pathstring—both—ROKSBNKCTL_TF_SOURCE_PATHPath is the local directory holding the Terraform tree when Type is "local".
tf_source.refstring—both—ROKSBNKCTL_TF_SOURCE_REFRef is the tag, branch or commit to fetch when Type is "github".
tf_source.repostring—both—ROKSBNKCTL_TF_SOURCE_REPORepo is the owner/name to fetch from when Type is "github".
tf_source.typestringyesboth—ROKSBNKCTL_TF_SOURCE_TYPEType selects where the Terraform comes from: "embedded" (the tree compiled into this binary — the default, and the only one guaranteed to match it), "github" (a released tree), or "local" (a path on disk, for testing a fork).

Set outside config.yaml

Supplied from the environment rather than the file. Where a _b64 field also exists, the environment wins — so a runner can override a stored value without editing the workspace. A credential written into config.yaml is a credential in your backups and, if you are careless, your git remote: scripts/generate_b64_password.sh keeps it out of your shell history at least.

Environment variable Sets How to supply it
IBMCLOUD_API_KEYThe IBM Cloud API key every phase authenticates with.Exported in the environment, or resolved per ibmcloud.api_key_source (env | keychain | config | prompt). Also settable as ibmcloud.api_key_b64, which stores it in the workspace.
BNK_FORGE_PASSWORDThe BNK Forge login password.Exported in the environment, passed as --password, stored as bnkforge.password_b64, or typed at the prompt — in that precedence. The resulting session token is cached in the OS keychain, so the password is normally used once. scripts/generate_b64_password.sh produces the stored form.
BNK_FORGE_USERThe BNK Forge login user.Overrides bnkforge.username, which IS a config.yaml field. Also settable as --username.
BNK_FORGE_URLThe BNK Forge server URL.Overrides bnkforge.url, which IS a config.yaml field. Also settable as --url.