config.yaml cheatsheet v1.64.0Every 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.
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.default | string | — | both | — | — | Default is the agentic CLI `roksbnkctl agent` (no arg) reports as this workspace's default — claude | gemini | aider | openai | pi | opencode. |
agent.llm_endpoint | string | — | 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.advanced | map[string]AdvancedComponentCfg | — | both | — | — | Advanced carries per-component environment passthrough for the 2.4 CNEInstance's advanced.<component>.env[] lists (#175). |
bnk.cert_manager.namespace | string | — | both | — | ROKSBNKCTL_CERT_MANAGER_NAMESPACE | Namespace cert-manager installs into (rendered as cert_manager_namespace). |
bnk.cert_manager.version | string | — | both | — | ROKSBNKCTL_CERT_MANAGER_VERSION | Version pins the cert-manager Helm chart (rendered as cert_manager_version). |
bnk.cis.bigip_password_b64 | string | — | both | — | ROKSBNKCTL_BIGIP_PASSWORD | BigIPPasswordB64 is that account's password, base64-encoded — obfuscation, not encryption. |
bnk.cis.bigip_url | string | — | both | — | ROKSBNKCTL_BIGIP_URL | BigIPURL 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_username | string | — | both | — | ROKSBNKCTL_BIGIP_USERNAME | BigIPUsername is the account CIS authenticates to that BIG-IP as. |
bnk.cluster_identifier | string | — | 2.4 | — | ROKSBNKCTL_CLUSTER_IDENTIFIER | ClusterIdentifier is passed to the external BIG-IP controller. |
bnk.cneinstance_size | string | — | both | — | ROKSBNKCTL_CNEINSTANCE_SIZE | CNEInstanceSize is the CNEInstance deploymentSize: Tiny, Small, Medium, Large or Max. |
bnk.demo_mode | *bool | — | both | false on 2.4, true on 2.3 | ROKSBNKCTL_DEMO_MODE | DemoMode sets advanced.demoMode.enabled. |
bnk.external_bigip | *bool | — | 2.4 | false | ROKSBNKCTL_EXTERNAL_BIGIP | ExternalBigIP enables the external BIG-IP controller. |
bnk.external_bigip_login_secret | string | — | 2.4 | f5-bigip-ctlr-login | ROKSBNKCTL_EXTERNAL_BIGIP_LOGIN_SECRET | ExternalBigIPLoginSecret holds the external BIG-IP credentials. |
bnk.far_auth_file | string | — | both | — | ROKSBNKCTL_FAR_AUTH_FILE | FarAuthFile 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_file | string | — | both | — | ROKSBNKCTL_FAR_AUTH_LOCAL_FILE | FarAuthLocalFile / SubscriptionJWTLocalFile point at LOCAL files instead of COS objects. |
bnk.far_repo_url | string | — | both | repo.f5.com | ROKSBNKCTL_FAR_REPO_URL | FARRepoURL is the F5 Artifact Repository charts are pulled from. |
bnk.flo_namespace | string | — | both | f5-bnk | ROKSBNKCTL_FLO_NAMESPACE | FLONamespace / FLOUtilsNamespace override the namespaces the F5 Lifecycle Operator and its utility components install into (rendered as flo_namespace / flo_utils_namespace). |
bnk.flo_utils_namespace | string | — | both | f5-utils | ROKSBNKCTL_FLO_UTILS_NAMESPACE | FLOUtilsNamespace 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_version | string | — | both | — | ROKSBNKCTL_FLP_CHART_VERSION | ChartVersion pins the f5-license-proxy chart. |
bnk.flp.external.root_ca_b64 | string | — | both | — | ROKSBNKCTL_FLP_ROOT_CA_B64 | RootCAB64 is the proxy's root CA, base64-encoded (as `flp output` emits it). |
bnk.flp.external.url | string | — | both | — | ROKSBNKCTL_FLP_EXTERNAL_URL | URL of the proxy, e.g. https://10.240.64.5:30001 — reachable from THIS cluster's pods. |
bnk.flp.mode | string | — | both | — | ROKSBNKCTL_FLP_MODE | Mode selects HOW the FLP phase deploys the proxy: "" | "helm" → the f5-license-proxy Helm chart into the ROKS cluster (default). |
bnk.flp.namespace | string | — | both | — | ROKSBNKCTL_FLP_NAMESPACE | Namespace the FLP is installed into (helm mode). |
bnk.flp.node_port_access | bool | — | both | — | ROKSBNKCTL_FLP_NODE_PORT_ACCESS | NodePortAccess 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_CIDRS | NodePortSourceCIDRs, 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_class | string | — | both | — | ROKSBNKCTL_FLP_STORAGE_CLASS | StorageClass 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_CIDRS | AllowedCIDRs is DEPRECATED — a legacy single list. |
bnk.flp.vsi.boot_size_gb | int | — | both | — | ROKSBNKCTL_FLP_VSI_BOOT_SIZE_GB | BootSizeGB is the boot volume size. |
bnk.flp.vsi.create_vpc | bool | — | both | — | ROKSBNKCTL_FLP_VSI_CREATE_VPC | CreateVPC 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_IP | FloatingIP 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.host | string | — | both | — | ROKSBNKCTL_FLP_VSI_FORWARD_PROXY_HOST | Host is the forward proxy's address. |
bnk.flp.vsi.forward_proxy.port | int | — | both | — | ROKSBNKCTL_FLP_VSI_FORWARD_PROXY_PORT | Port is the forward proxy's port. |
bnk.flp.vsi.forward_proxy.protocol | string | — | both | — | ROKSBNKCTL_FLP_VSI_FORWARD_PROXY_PROTOCOL | http (default) | https |
bnk.flp.vsi.licensing_allowed_cidrs | []string | — | both | — | ROKSBNKCTL_FLP_VSI_LICENSING_ALLOWED_CIDRS | LicensingAllowedCIDRs 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_CIDRS | ManagementAllowedCIDRs are the source CIDRs permitted to reach the :80 flp-status web UI (read-only status). |
bnk.flp.vsi.name_prefix | string | — | both | — | ROKSBNKCTL_FLP_VSI_NAME_PREFIX | NamePrefix 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.profile | string | — | both | — | ROKSBNKCTL_FLP_VSI_PROFILE | Profile is the IBM Cloud VSI instance profile. |
bnk.flp.vsi.ssh_key | string | — | both | — | ROKSBNKCTL_FLP_VSI_SSH_KEY | SSHKey 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_image | string | — | both | — | ROKSBNKCTL_FLP_VSI_STATUS_IMAGE | StatusImage, 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_b64 | string | — | both | — | ROKSBNKCTL_FLP_VSI_STATUS_REGISTRY_CA_B64 | StatusRegistryCAB64 is that registry's CA, base64-encoded, written to /etc/containers/certs.d/<host>/ca.crt on the VSI. |
bnk.flp.vsi.status_registry_host | string | — | both | — | ROKSBNKCTL_FLP_VSI_STATUS_REGISTRY_HOST | StatusRegistryHost + 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_cidr | string | — | both | — | ROKSBNKCTL_FLP_VSI_SUBNET_CIDR | SubnetCIDR is the address prefix for that VPC. |
bnk.flp.vsi.vpc | string | — | both | — | ROKSBNKCTL_FLP_VSI_VPC | VPC is an existing VPC id to deploy the standalone FLP VSI into, WITHOUT any ROKS cluster. |
bnk.flp.vsi.vpc_name | string | — | both | — | ROKSBNKCTL_FLP_VSI_VPC_NAME | VPCName names the VPC created when CreateVPC is set. |
bnk.flp.vsi.zone | string | — | both | — | ROKSBNKCTL_FLP_VSI_ZONE | Zone the VSI lands in (e.g. us-south-1). |
bnk.gateway_api_bundle_url | string | — | 2.4 | — | ROKSBNKCTL_GATEWAY_API_BUNDLE_URL | GatewayAPIBundleURL is where the Gateway API standard-install bundle is FETCHED from when `gateway_api_mtls` is on (#185). |
bnk.gateway_api_mtls | bool | — | 2.4 | — | ROKSBNKCTL_GATEWAY_API_MTLS | GatewayAPIMTLS opts into the Gateway API bundle BNK 2.4 needs for mTLS (#170). |
bnk.gateway_api_version | string | — | 2.4 | 1.5.0 | ROKSBNKCTL_GATEWAY_API_VERSION | GatewayAPIVersion is GATEWAY_API_VERSION for the CNE controller. |
bnk.gslb_datacenter_name | string | — | both | — | ROKSBNKCTL_GSLB_DATACENTER_NAME | GSLBDatacenterName sets the optional CNEInstance GSLB datacenter name (rendered as cneinstance_gslb_datacenter_name). |
bnk.hugepages.count | int | — | both | 2048 | ROKSBNKCTL_HUGEPAGES_COUNT | Count is the number of pages PER NODE. |
bnk.hugepages.enabled | bool | — | both | — | ROKSBNKCTL_HUGEPAGES | Enabled allocates hugepages. |
bnk.hugepages.node_role | string | — | both | worker | ROKSBNKCTL_HUGEPAGES_NODE_ROLE | NodeRole is the machineconfiguration.openshift.io/role the profile applies to. |
bnk.hugepages.profile_name | string | — | both | bnk-hugepages | ROKSBNKCTL_HUGEPAGES_PROFILE_NAME | ProfileName names the Tuned profile and CR. |
bnk.hugepages.size | string | — | both | 2M | ROKSBNKCTL_HUGEPAGES_SIZE | Size is the hugepage size, e.g. "2M" or "1G". |
bnk.license_mode | string | — | both | connected | ROKSBNKCTL_LICENSE_MODE | LicenseMode selects the License CR operationMode: "connected" (default when empty), "disconnected", or "f5licenseproxy". |
bnk.manifest_version | string | — | both | — | ROKSBNKCTL_MANIFEST_VERSION | ManifestVersion pins the BNK release, e.g. "2.4.0-EA". |
bnk.network.tmm_k8s_routes | string | — | both | 172.17.0.0/18 | ROKSBNKCTL_TMM_K8S_ROUTES | TMMK8SRoutes 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.3 | 24 | ROKSBNKCTL_VLAN_PREFIXLEN | VLANPrefixLen 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_EXTERNAL | VLANPrefixLenExternal / VLANPrefixLenInternal override VLANPrefixLen for one VLAN. |
bnk.network.vlan_prefixlen_internal | *int | — | 2.3 | — | ROKSBNKCTL_VLAN_PREFIXLEN_INTERNAL | VLANPrefixLenInternal 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_cidr | string | — | both | — | ROKSBNKCTL_ZONE1_EXT_VLAN_CIDR / ROKSBNKCTL_ZONE2_EXT_VLAN_CIDR / ROKSBNKCTL_ZONE3_EXT_VLAN_CIDR | ExtVLANCIDR is the zone's EXTERNAL VLAN — the client side of the data plane, where traffic arrives. |
bnk.network.zones[].external_selfip | string | — | 2.3 | — | ROKSBNKCTL_ZONE1_EXTERNAL_SELFIP / ROKSBNKCTL_ZONE2_EXTERNAL_SELFIP / ROKSBNKCTL_ZONE3_EXTERNAL_SELFIP | ExternalSelfIP is TMM's own address on the external VLAN. |
bnk.network.zones[].int_snat_cidr | string | — | both | — | ROKSBNKCTL_ZONE1_INT_SNAT_CIDR / ROKSBNKCTL_ZONE2_INT_SNAT_CIDR / ROKSBNKCTL_ZONE3_INT_SNAT_CIDR | IntSNATCIDR 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_cidr | string | — | both | — | ROKSBNKCTL_ZONE1_INT_VIP_CIDR / ROKSBNKCTL_ZONE2_INT_VIP_CIDR / ROKSBNKCTL_ZONE3_INT_VIP_CIDR | IntVIPCIDR is the range virtual servers are allocated from on the internal side. |
bnk.network.zones[].int_vlan_cidr | string | — | 2.3 | — | ROKSBNKCTL_ZONE1_INT_VLAN_CIDR / ROKSBNKCTL_ZONE2_INT_VLAN_CIDR / ROKSBNKCTL_ZONE3_INT_VLAN_CIDR | IntVLANCIDR is the zone's INTERNAL VLAN — the pod side, where BNK reaches the workloads it fronts. |
bnk.network.zones[].internal_selfip | string | — | 2.3 | — | ROKSBNKCTL_ZONE1_INTERNAL_SELFIP / ROKSBNKCTL_ZONE2_INTERNAL_SELFIP / ROKSBNKCTL_ZONE3_INTERNAL_SELFIP | InternalSelfIP is TMM's own address on the internal VLAN. |
bnk.preflight.reachability_retry_seconds | *int | — | both | — | ROKSBNKCTL_REACHABILITY_RETRY_SECONDS | ReachabilityRetrySeconds is how long a target may keep failing before the verdict is believed. |
bnk.preflight.reachability_timeout_seconds | *int | — | both | — | ROKSBNKCTL_REACHABILITY_TIMEOUT_SECONDS | ReachabilityTimeoutSeconds is how long to wait for the probe DaemonSet to report from every node. |
bnk.storage_class_name | string | — | both | — | ROKSBNKCTL_STORAGE_CLASS_NAME | StorageClassName is the StorageClass the CNEInstance's persistent volumes use, TMM's included. |
bnk.subscription_jwt_file | string | — | both | — | ROKSBNKCTL_SUBSCRIPTION_JWT_FILE | SubscriptionJWTFile 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_file | string | — | both | — | ROKSBNKCTL_SUBSCRIPTION_JWT_LOCAL_FILE | SubscriptionJWTLocalFile is the F5 subscription JWT as a LOCAL file, the companion to FarAuthLocalFile above. |
bnk.tcp_settings | map[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_name | string | — | both | sys-default-tcp | ROKSBNKCTL_TCP_SETTINGS_NAME | TCPSettingsName is the F5BigTcpSetting to write. |
bnk.tmm_anti_affinity | *bool | — | 2.4 | true | ROKSBNKCTL_TMM_ANTI_AFFINITY | TMMAntiAffinity requires f5-tmm pods onto different nodes. |
bnk.tmm_anti_affinity_topology_key | string | — | 2.4 | kubernetes.io/hostname | ROKSBNKCTL_TMM_ANTI_AFFINITY_TOPOLOGY_KEY | TMMAntiAffinityTopologyKey is the node label the anti-affinity rule spreads across — the IBM ROKS per-node label. |
bnk.tmm_pod_label | string | — | 2.4 | f5-tmm | ROKSBNKCTL_TMM_POD_LABEL | TMMPodLabel is the `app` label value the placement rules select TMM by. |
bnk.tmm_replicas | int | — | 2.4 | 3 | ROKSBNKCTL_TMM_REPLICAS | TMMReplicas is the number of f5-tmm data-plane replicas. |
bnk.tmm_resources | map[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.4 | true | ROKSBNKCTL_TMM_ROLLING_UPDATE | TMMRollingUpdate 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_skew | int | — | 2.4 | 1 | ROKSBNKCTL_TMM_ZONE_MAX_SKEW | TMMZoneMaxSkew is maxSkew for the zone topology-spread constraint. |
bnk.tmm_zone_spread | *bool | — | 2.4 | true | ROKSBNKCTL_TMM_ZONE_SPREAD | TMMZoneSpread spreads f5-tmm pods across zones. |
bnk.tmm_zone_topology_key | string | — | 2.4 | topology.kubernetes.io/zone | ROKSBNKCTL_TMM_ZONE_TOPOLOGY_KEY | TMMZoneTopologyKey is the IBM ROKS zone label the spread constraint uses. |
bnk.tmm_zone_when_unsatisfiable | string | — | 2.4 | DoNotSchedule | ROKSBNKCTL_TMM_ZONE_WHEN_UNSATISFIABLE | TMMZoneWhenUnsatisfiable is DoNotSchedule or ScheduleAnyway. |
bnk.trusted_profile.roles | []string | — | both | [Viewer, Editor] | ROKSBNKCTL_TRUSTED_PROFILE_ROLES | Roles granted to the profile, scoped to the cluster's OWN VPC. |
bnk.trusted_profile.service_account | string | — | both | — | ROKSBNKCTL_TRUSTED_PROFILE_SA | ServiceAccount is the Kubernetes service account the profile is LINKED to: which account may assume it. |
bnk.watch_namespaces | []string | — | 2.4 | All | ROKSBNKCTL_WATCH_NAMESPACES | WatchNamespaces are the namespaces the CNE controller watches. |
bnk.whole_cluster | *bool | — | both | false on 2.4, true on 2.3 | ROKSBNKCTL_WHOLE_CLUSTER | TCPSettings 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_b64 | string | — | both | — | ROKSBNKCTL_BNKFORGE_CA_B64 | CAB64 pins the CA the Forge server's certificate must chain to, PEM, base64-encoded. |
bnkforge.insecure | bool | — | both | — | ROKSBNKCTL_BNKFORGE_INSECURE | Insecure skips TLS verification against the Forge server. |
bnkforge.password_b64 | string | — | both | — | ROKSBNKCTL_BNKFORGE_PASSWORD | PasswordB64 is that user's password, base64-encoded — obfuscation, NOT encryption, exactly as bnk.cis.bigip_password_b64 and registry.generic_password_b64 are. |
bnkforge.project | string | — | both | — | ROKSBNKCTL_BNKFORGE_PROJECT | Project is the target BNK Forge project NAME. |
bnkforge.register | bool | — | both | — | ROKSBNKCTL_BNKFORGE_REGISTER | Register opts the workspace in. |
bnkforge.url | string | — | both | — | ROKSBNKCTL_BNKFORGE_URL | URL is the BNK Forge server base URL (e.g. https://forge.example.com). |
bnkforge.username | string | — | both | — | ROKSBNKCTL_BNKFORGE_USERNAME | Username 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.create | bool | — | both | — | ROKSBNKCTL_CLUSTER_CREATE | Create decides whether this workspace BUILDS the ROKS cluster or adopts one that already exists. |
cluster.existing_subnet_ids | []string | — | both | — | ROKSBNKCTL_EXISTING_SUBNET_IDS | ExistingSubnetIDs places the cluster in subnets that ALREADY EXIST, one per zone in zone order, instead of creating them (#61). |
cluster.min_worker_memory_gb | int | — | both | 64 | ROKSBNKCTL_MIN_WORKER_MEMORY_GB | MinWorkerMemoryGB is the memory floor for the same auto-select. |
cluster.min_worker_vcpu_count | int | — | both | 16 | ROKSBNKCTL_MIN_WORKER_VCPU_COUNT | MinWorkerVCPUCount is the vCPU floor for the worker-flavor auto-select: the cluster module picks the smallest bx2 profile meeting this and MinWorkerMemoryGB. |
cluster.name | string | — | both | — | ROKSBNKCTL_CLUSTER_NAME | Name is the ROKS cluster's name — the one to create, or the existing one to adopt when Create is false. |
cluster.network_mode | string | — | both | single-nic | ROKSBNKCTL_CLUSTER_NETWORK_MODE | NetworkMode selects how the cluster's worker nodes are attached: "single-nic" (the default, and today's only behaviour) or "multi-nic". |
cluster.openshift_version | string | — | both | — | ROKSBNKCTL_OPENSHIFT_VERSION | OpenShiftVersion pins the OpenShift version for a CREATED cluster (e.g. "4.20"). |
cluster.public_gateway | *bool | — | both | true | ROKSBNKCTL_CLUSTER_PUBLIC_GATEWAY | PublicGateway controls whether the cluster subnets attach a public gateway for worker Internet egress. |
cluster.vpc_cidr | string | — | both | — | ROKSBNKCTL_CLUSTER_VPC_CIDR | VPCCIDR 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_flavor | string | — | both | — | ROKSBNKCTL_WORKER_FLAVOR | WorkerFlavor names the worker profile EXACTLY, e.g. "cx3d.8x20". |
cluster.workers_per_zone | int | — | both | 1 | ROKSBNKCTL_WORKERS_PER_ZONE | WorkersPerZone 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.bucket | string | — | both | bnk-artifacts | ROKSBNKCTL_COS_BUCKET | Bucket is the bucket the FAR service-account credential is read from, for estates that stage it centrally rather than passing a local file. |
cos.instance | string | — | both | bnk-supply-chain | ROKSBNKCTL_COS_INSTANCE | Instance is the IBM Cloud Object Storage service instance holding the bucket. |
cos.region | string | — | both | us-south | ROKSBNKCTL_COS_REGION | Region is the bucket's region, which need not match ibmcloud.region. |
cos.resource_group | string | — | 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[].key | string | — | both | — | — | Key is the object name it is stored under in the bucket. |
cos.upload[].source | string | — | both | — | — | Source is the local file to upload. |
exec Exec is the per-tool execution-backend config block introduced in Sprint 3 (PRD 03). | ||||||
exec | map[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_namespace | string | — | both | f5-app | ROKSBNKCTL_GATEWAY_APP_NAMESPACE | AppNamespace is the namespace the example application and its Gateway resources are created in. |
gateway.backend_port | int | — | both | 80 | ROKSBNKCTL_GATEWAY_BACKEND_PORT | BackendPort is the port on that Service. |
gateway.backend_service | string | — | both | nginx-service | ROKSBNKCTL_GATEWAY_BACKEND_SERVICE | BackendService is the Kubernetes Service the example HTTPRoute forwards to. |
gateway.class_name | string | — | both | gateway-class | ROKSBNKCTL_GATEWAY_CLASS_NAME | ClassName is the GatewayClass name. |
gateway.client_subnet_local | []string | — | both | — | ROKSBNKCTL_GATEWAY_CLIENT_SUBNET_LOCAL | ClientSubnetLocal 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_REMOTE | ClientSubnetRemote lists client CIDRs reached ACROSS the transit gateway, e.g. the testing client VPC. |
gateway.controller_name | string | — | both | — | ROKSBNKCTL_GATEWAY_CONTROLLER_NAME | ControllerName is the GatewayClass controllerName. |
gateway.egress_mode | string | — | both | snatpool | ROKSBNKCTL_GATEWAY_EGRESS_MODE | EgressMode selects how return traffic is source-addressed: "snatpool", "automap", or "both". |
gateway.l4_listener_port | int | — | both | 8080 | ROKSBNKCTL_GATEWAY_L4_LISTENER_PORT | L4ListenerPort is the port for that TCP listener. |
gateway.route_examples | []string | — | both | — | ROKSBNKCTL_GATEWAY_ROUTE_EXAMPLES | RouteExamples names extra route kinds to create WORKING examples of, alongside the HTTPRoute the gateway phase already creates. |
gateway.vxlan_port | int | — | both | 6789 | ROKSBNKCTL_GATEWAY_VXLAN_PORT | VXLANPort 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_b64 | string | — | both | — | IBMCLOUD_API_KEY / ROKSBNKCTL_API_KEY_B64 | APIKeyB64 stores the API key base64-encoded inline in the workspace config. |
ibmcloud.api_key_source | string | — | both | — | ROKSBNKCTL_API_KEY_SOURCE | env | keychain | config | prompt — see secrets.go |
ibmcloud.region | string | yes | both | — | ROKSBNKCTL_REGION | Region is the IBM Cloud region everything in this workspace is created in or adopted from, e.g. "us-east". |
ibmcloud.resource_group | string | yes | both | default | ROKSBNKCTL_RESOURCE_GROUP | ResourceGroup 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. | ||||||
prefix | string | yes | both | — | ROKSBNKCTL_PREFIX | Prefix 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_b64 | string | — | both | — | ROKSBNKCTL_GENERIC_CA_B64 | GenericCAB64 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_sha256 | string | — | both | — | ROKSBNKCTL_GENERIC_CA_SHA256 | GenericCASHA256 pins the mirror's CA by SHA-256 (hex; a "sha256:" prefix and colons are accepted). |
registry.generic_host | string | — | both | — | ROKSBNKCTL_GENERIC_HOST | GenericHost is the OCI registry host for target=generic (e.g. "artifactory.example.com"). |
registry.generic_password_b64 | string | — | both | — | ROKSBNKCTL_GENERIC_PASSWORD | GenericPasswordB64 is that user's password or access token, base64-encoded — obfuscation, not encryption. |
registry.generic_repo_prefix | string | — | both | — | ROKSBNKCTL_GENERIC_REPO_PREFIX | GenericRepoPrefix is the repository path artifacts nest under for target=generic (e.g. an Artifactory repo key). |
registry.generic_username | string | — | both | — | ROKSBNKCTL_GENERIC_USERNAME | GenericUsername / GenericPasswordB64 are the static basic-auth credential for target=generic (an Artifactory user + access token). |
registry.icr_host | string | — | both | — | ROKSBNKCTL_ICR_HOST | ICRHost overrides the IBM Container Registry host for target=icr (e.g. "de.icr.io"). |
registry.icr_namespace | string | — | both | — | ROKSBNKCTL_ICR_NAMESPACE | ICRNamespace is the ICR namespace artifacts nest under for target=icr. |
registry.include_deps | *bool | — | both | — | ROKSBNKCTL_REGISTRY_INCLUDE_DEPS | IncludeDeps unions the non-F5 dependency artifacts (Jetstack cert-manager chart + images, the registry.k8s.io/kubectl node-labeler image) into the BOM. |
registry.namespace | string | — | both | — | ROKSBNKCTL_REGISTRY_NAMESPACE | Namespace is the mirror project the artifacts land in. |
registry.source_service_account_b64 | string | — | both | — | ROKSBNKCTL_SOURCE_SERVICE_ACCOUNT_B64 | SourceServiceAccountB64 is the FAR `_json_key_base64` service-account JSON, base64-encoded, used as the replication SOURCE credential for repo.f5.com. |
registry.target | string | — | both | — | ROKSBNKCTL_REGISTRY_TARGET | Target 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.create | bool | — | both | — | ROKSBNKCTL_BNK_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.bnk.existing | string | — | both | — | ROKSBNKCTL_BNK_EXISTING | Existing is the name or ID of the resource to adopt when Create is false. |
resources.cert_manager.create | bool | — | both | — | ROKSBNKCTL_CERT_MANAGER_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.cert_manager.existing | string | — | both | — | ROKSBNKCTL_CERT_MANAGER_EXISTING | Existing is the name or ID of the resource to adopt when Create is false. |
resources.client_region | string | — | both | — | ROKSBNKCTL_CLIENT_REGION | ClientRegion is the region the testing client (TGW jumphost + client VPC) is installed in. |
resources.client_vpc.create | bool | — | both | — | ROKSBNKCTL_CLIENT_VPC_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.client_vpc.existing | string | — | both | — | ROKSBNKCTL_CLIENT_VPC_NAME | Existing 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_CIDRS | ClusterHTTPAllowedCIDRs 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.create | bool | — | both | — | ROKSBNKCTL_CLUSTER_JUMPHOSTS_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.cluster_jumphosts.existing | string | — | both | — | ROKSBNKCTL_CLUSTER_JUMPHOSTS_EXISTING | Existing is the name or ID of the resource to adopt when Create is false. |
resources.cluster_vpc.create | bool | — | both | — | ROKSBNKCTL_CLUSTER_VPC_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.cluster_vpc.existing | string | — | both | — | ROKSBNKCTL_CLUSTER_VPC_ID | Existing 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_CIDRS | ClusterVPCDefaultSGInboundCIDRs 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_FILES | CopiedSSHKeyFiles 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.create | bool | — | both | — | ROKSBNKCTL_REGISTRY_COS_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.registry_cos.existing | string | — | both | — | ROKSBNKCTL_REGISTRY_COS_EXISTING | Existing 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_CIDRS | TestingClientVPCInboundCIDRs gates the client VPC's DEFAULT security group, which the testing phase widens to all protocols and ports. |
resources.testing_client_vpc_name | string | — | both | tf-testing-vpc | ROKSBNKCTL_TESTING_VPC_NAME | TestingClientVPCName 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_CIDRS | Security-group source CIDRs, following the flp_vsi module's split between a management plane and an in-fabric plane. |
resources.testing_jumphost_profile | string | — | both | — | ROKSBNKCTL_TESTING_JUMPHOST_PROFILE | Jumphost sizing. |
resources.testing_min_memory_gb | int | — | both | 8 | ROKSBNKCTL_TESTING_MIN_MEMORY_GB | TestingMinMemoryGB is the memory floor for the same auto-select. |
resources.testing_min_vcpu_count | int | — | both | 4 | ROKSBNKCTL_TESTING_MIN_VCPU_COUNT | TestingMinVCPUCount is the vCPU floor for the jumphost auto-select. |
resources.testing_ssh_key_name | string | — | both | — | ROKSBNKCTL_TESTING_SSH_KEY_NAME | TestingSSHKeyName is the IBM Cloud VPC SSH key name attached to the testing jumphosts (rendered as testing_ssh_key_name). |
resources.tgw_jumphost.create | bool | — | both | — | ROKSBNKCTL_TGW_JUMPHOST_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.tgw_jumphost.existing | string | — | both | — | ROKSBNKCTL_TGW_JUMPHOST_EXISTING | Existing is the name or ID of the resource to adopt when Create is false. |
resources.transit_gateway.create | bool | — | both | — | ROKSBNKCTL_TRANSIT_GATEWAY_CREATE | Create decides whether roksbnkctl provisions this resource or adopts one that already exists. |
resources.transit_gateway.existing | string | — | both | — | ROKSBNKCTL_TRANSIT_GATEWAY_NAME | Existing 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.backend | string | — | both | — | — | "" | "local" | "s3" |
state.s3.access_key_source | string | — | both | — | — | env var name; default ROKSBNKCTL_COS_HMAC_ACCESS_KEY |
state.s3.bucket | string | — | both | — | — | pre-provisioned bucket |
state.s3.endpoint | string | — | both | — | — | COS S3 endpoint URL |
state.s3.key_prefix | string | — | both | — | — | default: the workspace name |
state.s3.region | string | — | both | — | — | COS location / region |
state.s3.secret_key_source | string | — | 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. | ||||||
targets | map[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_target | string | — | both | — | — | DefaultTarget is the resolver queried when a probe names none. |
test.dns.resolvers | map[string]string | — | both | — | — | Resolvers names the DNS servers to query, as name → "<ip>[:<port>]". |
test.throughput.default_mode | string | — | both | north-south | — | north-south | east-west |
test.throughput.duration | int | — | both | 30 | — | seconds; default 30 |
test.throughput.image | string | — | both | networkstatic/iperf3:latest | — | default: networkstatic/iperf3:latest |
test.throughput.streams | int | — | both | 8 | — | 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.path | string | — | both | — | ROKSBNKCTL_TF_SOURCE_PATH | Path is the local directory holding the Terraform tree when Type is "local". |
tf_source.ref | string | — | both | — | ROKSBNKCTL_TF_SOURCE_REF | Ref is the tag, branch or commit to fetch when Type is "github". |
tf_source.repo | string | — | both | — | ROKSBNKCTL_TF_SOURCE_REPO | Repo is the owner/name to fetch from when Type is "github". |
tf_source.type | string | yes | both | — | ROKSBNKCTL_TF_SOURCE_TYPE | Type 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). |
config.yamlSupplied 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_KEY | The 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_PASSWORD | The 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_USER | The BNK Forge login user. | Overrides bnkforge.username, which IS a config.yaml field. Also settable as --username. |
BNK_FORGE_URL | The BNK Forge server URL. | Overrides bnkforge.url, which IS a config.yaml field. Also settable as --url. |