Documentation
¶
Overview ¶
Package roksbnkctl exposes the embedded Terraform source tree as an embed.FS so the compiled binary ships with the matched HCL — no separate TF download for the default deploy path. External tf_source overrides (a GitHub release, a local path) bypass this and still work for users who want to test forks.
This file lives at the module root because //go:embed paths are resolved relative to the source file's directory and Go forbids embedding paths outside the embedding file's package — so the embedding shim has to sit alongside ./terraform/.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var EmbeddedTerraform embed.FS
EmbeddedTerraform is the entire ./terraform/ tree (HCL root + modules + terraform.tfvars.example). Walked at runtime by tf.FetchSource when the workspace's tf_source is unset / type=embedded, and extracted into the workspace state dir for terraform-exec to operate on.
Two directives, deliberately.
The first embeds the committed HCL. It is NOT `all:terraform`: the `all:` prefix pulls in dotfiles, including the gitignored `.terraform/` provider/module cache (~400MB of plugin binaries) that a local `terraform init`/`validate` leaves in ./terraform during development. Embedding that bloated the binary to ~670MB AND, once extracted (extractEmbeddedTF writes 0644), shipped non-executable provider binaries that broke `terraform plan` with "fork/exec ... permission denied".
The second names .terraform.lock.hcl explicitly, because a plain directory pattern skips every dotfile and this one has to ship (#147). It pins each provider to an exact version and records the checksums `terraform init` verifies downloads against. Without it in the binary, `init` runs in the extract directory against the `>=` constraints in versions.tf alone, so two operators running the same release on different days can resolve different providers, and nothing verifies what the registry serves. CI ran against the committed lockfile while every user got a freshly resolved set.
An explicit path is what keeps this from costing anything: it ships the one dotfile that matters without reopening the `all:` problem above.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
flp-status
command
Command flp-status serves the F5 License Proxy status web UI.
|
Command flp-status serves the F5 License Proxy status web UI. |
|
roksbnkctl
command
Command roksbnkctl is the user-facing CLI entrypoint.
|
Command roksbnkctl is the user-facing CLI entrypoint. |
|
internal
|
|
|
bnkbom
Package bnkbom builds the bill-of-materials (BOM) of artifacts a BNK install needs — every helm chart and container image — by parsing the f5-bigip-k8s-manifest that FAR publishes per BNK release, and unioning the non-F5 dependencies roksbnkctl installs that the manifest does not cover (cert-manager from Jetstack, bitnami/kubectl for the node-labeler).
|
Package bnkbom builds the bill-of-materials (BOM) of artifacts a BNK install needs — every helm chart and container image — by parsing the f5-bigip-k8s-manifest that FAR publishes per BNK release, and unioning the non-F5 dependencies roksbnkctl installs that the manifest does not cover (cert-manager from Jetstack, bitnami/kubectl for the node-labeler). |
|
cli
Package cli wires the cobra command tree for roksbnkctl.
|
Package cli wires the cobra command tree for roksbnkctl. |
|
config
Package config loads workspace and global configuration, resolves the IBM Cloud API key (env / OS keychain / prompt), and renders Terraform variables files.
|
Package config loads workspace and global configuration, resolves the IBM Cloud API key (env / OS keychain / prompt), and renders Terraform variables files. |
|
cos
Package cos wraps IBM/ibm-cos-sdk-go for COS bucket and object I/O. The SDK is S3-compatible (literally a fork of AWS S3 SDK with IBM IAM auth bolted in), so the operations look familiar:
|
Package cos wraps IBM/ibm-cos-sdk-go for COS bucket and object I/O. The SDK is S3-compatible (literally a fork of AWS S3 SDK with IBM IAM auth bolted in), so the operations look familiar: |
|
cred
Package cred is the single source of truth for credential resolution across roksbnkctl execution backends.
|
Package cred is the single source of truth for credential resolution across roksbnkctl execution backends. |
|
doctor
Package doctor implements the prerequisite checks used by `roksbnkctl doctor`.
|
Package doctor implements the prerequisite checks used by `roksbnkctl doctor`. |
|
embedded
Package embedded ships the agentic-mode scaffolding inside the binary.
|
Package embedded ships the agentic-mode scaffolding inside the binary. |
|
exec
Package exec defines the Backend interface and per-backend implementations roksbnkctl uses to run external tools (ibmcloud, kubectl, terraform, iperf3, etc.).
|
Package exec defines the Backend interface and per-backend implementations roksbnkctl uses to run external tools (ibmcloud, kubectl, terraform, iperf3, etc.). |
|
exitcode
Package exitcode defines roksbnkctl's exit-code contract and the error type that carries a code out of a command.
|
Package exitcode defines roksbnkctl's exit-code contract and the error type that carries a code out of a command. |
|
flp
Package flp holds the F5 License Proxy install's chart fix-ups.
|
Package flp holds the F5 License Proxy install's chart fix-ups. |
|
flpstatus
Package flpstatus gathers and serves the runtime status of an F5 License Proxy (FLP) — the same four-container stack whether it runs as a podman pod on a standalone VSI or as the helm chart in a ROKS cluster.
|
Package flpstatus gathers and serves the runtime status of an F5 License Proxy (FLP) — the same four-container stack whether it runs as a podman pod on a standalone VSI or as the helm chart in a ROKS cluster. |
|
forge
Package forge is a small REST client for BNK Forge v3 (FastAPI).
|
Package forge is a small REST client for BNK Forge v3 (FastAPI). |
|
ibm
Package ibm wraps the IBM Cloud Go SDKs for everything that isn't COS bucket/object I/O:
|
Package ibm wraps the IBM Cloud Go SDKs for everything that isn't COS bucket/object I/O: |
|
k8s
Package k8s wraps client-go for roksbnkctl's internal Kubernetes operations:
|
Package k8s wraps client-go for roksbnkctl's internal Kubernetes operations: |
|
naming
Package naming derives every account-scoped IBM Cloud resource name a workspace needs from a single workspace prefix, and validates that prefix against the per-resource-type length/charset limits BEFORE terraform ever runs — so an over-long or malformed prefix is rejected at `init` time rather than mid-`apply` by IBM Cloud.
|
Package naming derives every account-scoped IBM Cloud resource name a workspace needs from a single workspace prefix, and validates that prefix against the per-resource-type length/charset limits BEFORE terraform ever runs — so an over-long or malformed prefix is rejected at `init` time rather than mid-`apply` by IBM Cloud. |
|
orchestration
Package orchestration is roksbnkctl's service layer: the lifecycle / cluster / remote-dispatch orchestration extracted out of the internal/cli god-package (Sprint 15 phase-1 decomposition), plus the single path/env normalization chokepoint that structurally retires the recurring "a value correct in the invocation context is wrong once it crosses a boundary" bug class (Sprint 12 Issues 1/2 + Sprint 13 Issue 1).
|
Package orchestration is roksbnkctl's service layer: the lifecycle / cluster / remote-dispatch orchestration extracted out of the internal/cli god-package (Sprint 15 phase-1 decomposition), plus the single path/env normalization chokepoint that structurally retires the recurring "a value correct in the invocation context is wrong once it crosses a boundary" bug class (Sprint 12 Issues 1/2 + Sprint 13 Issue 1). |
|
registry/mirror
Package mirror is the Sprint 29 replication engine: it copies the BNK bill-of-materials (charts + images) from their source registries into a single private target, idempotently and concurrently.
|
Package mirror is the Sprint 29 replication engine: it copies the BNK bill-of-materials (charts + images) from their source registries into a single private target, idempotently and concurrently. |
|
registry/ocireg
Package ocireg implements the Sprint 30 RegistryTarget for any STANDARD OCI registry that nests the FAR category under a configured namespace/repository prefix: "<host>/<namespace>/images/<name>".
|
Package ocireg implements the Sprint 30 RegistryTarget for any STANDARD OCI registry that nests the FAR category under a configured namespace/repository prefix: "<host>/<namespace>/images/<name>". |
|
registry/source
Package source is the FAR (F5 Artifact Repository, repo.f5.com) OCI source client for the Sprint 29 registry mirror (PRD 11 §3).
|
Package source is the FAR (F5 Artifact Repository, repo.f5.com) OCI source client for the Sprint 29 registry mirror (PRD 11 §3). |
|
remote
Package remote implements the embedded SSH client and related plumbing for roksbnkctl's --on <target> flag (PRD 01).
|
Package remote implements the embedded SSH client and related plumbing for roksbnkctl's --on <target> flag (PRD 01). |
|
sshkey
Package sshkey generates ed25519 SSH keypairs and writes them to disk for the testing jumphosts (the IBM Cloud VPC SSH key roksbnkctl uploads + manages).
|
Package sshkey generates ed25519 SSH keypairs and writes them to disk for the testing jumphosts (the IBM Cloud VPC SSH key roksbnkctl uploads + manages). |
|
test
Package test contains the deployment-validation probe runners for `roksbnkctl test`.
|
Package test contains the deployment-validation probe runners for `roksbnkctl test`. |
|
tf
Package tf wraps hashicorp/terraform-exec to drive `terraform init / plan / apply / destroy` against the pinned TF source for a roksbnkctl workspace.
|
Package tf wraps hashicorp/terraform-exec to drive `terraform init / plan / apply / destroy` against the pinned TF source for a roksbnkctl workspace. |
|
ui
Package ui provides terminal output primitives — spinners, progress bars, tables, structured logging, and JSON output formatting (versioned schema: "schema":"roksbnkctl.v1").
|
Package ui provides terminal output primitives — spinners, progress bars, tables, structured logging, and JSON output formatting (versioned schema: "schema":"roksbnkctl.v1"). |
|
tools
|
|
|
refgen/cobra-md
command
Command cobra-md walks the roksbnkctl cobra command tree and emits a single Markdown reference document on stdout.
|
Command cobra-md walks the roksbnkctl cobra command tree and emits a single Markdown reference document on stdout. |
|
refgen/config-cheatsheet
command
Command config-cheatsheet renders every possible config.yaml entry as a single self-contained HTML page.
|
Command config-cheatsheet renders every possible config.yaml entry as a single self-contained HTML page. |
|
refgen/config-md
command
Command config-md parses internal/config/workspace.go and emits the workspace `config.yaml` schema reference on stdout.
|
Command config-md parses internal/config/workspace.go and emits the workspace `config.yaml` schema reference on stdout. |
|
refgen/env-example
command
Command env-example generates the annotated .env template `roksbnkctl config env` prints.
|
Command env-example generates the annotated .env template `roksbnkctl config env` prints. |
|
refgen/mdesc
Package mdesc prepares free text that is about to be interpolated into markdown by the refgen tools.
|
Package mdesc prepares free text that is about to be interpolated into markdown by the refgen tools. |
|
refgen/tfvars-md
command
Command tfvars-md parses terraform/variables.tf (plus each submodule's own variables.tf) and emits a single Markdown reference document on stdout covering every Terraform variable with type, default, description, sensitive flag, and source file.
|
Command tfvars-md parses terraform/variables.tf (plus each submodule's own variables.tf) and emits a single Markdown reference document on stdout covering every Terraform variable with type, default, description, sensitive flag, and source file. |