Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/carlmontanari/boxen
/ functions
Functions
380 in github.com/carlmontanari/boxen
⨍
Functions
380
◇
Types & classes
58
↓ 36 callers
Method
Error
(msg string, args ...any)
agent/logging.go:39
↓ 36 callers
Method
Info
(msg string, args ...any)
agent/logging.go:29
↓ 28 callers
Function
NewAgent
NewAgent returns a new boxen Agent instance.
agent/agent.go:42
↓ 19 callers
Function
testQemuProfile
(managementPassthrough bool)
profile/qemu_test.go:134
↓ 18 callers
Method
String
()
proto/v1/server.pb.go:475
↓ 17 callers
Method
Debug
(msg string, args ...any)
agent/logging.go:24
↓ 17 callers
Method
Run
( ctx context.Context, l *slog.Logger, cfg *boxencontainertypes.RunConfig, )
container/container.go:24
↓ 14 callers
Method
RenderTemplate
RenderTemplate renders write content with named Go template values.
profile/formatters.go:145
↓ 12 callers
Function
NewFormatters
NewFormatters returns a Formatters object based on the given inputs/profile.
profile/formatters.go:107
↓ 12 callers
Function
fakeConsoleOutput
fakeConsoleOutput makes the agent read the given chunks, one per read call, then nothing.
agent/process_readuntil_test.go:15
↓ 10 callers
Function
file_proto_v1_server_proto_rawDescGZIP
()
proto/v1/server.pb.go:643
↓ 10 callers
Method
processStepReadUntil
(ctx context.Context, step *boxenprofile.Step)
agent/process.go:183
↓ 10 callers
Method
waitForEcho
waitForEcho waits until the console echoed written text, so that following input is not sent before the guest processed it. Whitespace is ignored, sin
agent/console.go:216
↓ 9 callers
Function
readUntilStep
(until string)
agent/process_readuntil_test.go:28
↓ 8 callers
Method
ApplyConfiguration
ApplyConfiguration lets profile Starlark derive VM settings before argument generation. Only a validated result replaces the current settings.
profile/configure.go:15
↓ 8 callers
Function
QemuArgsFromProfile
QemuArgsFromProfile builds the qemu launch args from the given profile/disk.
profile/qemu.go:40
↓ 8 callers
Function
qemuMgmtNIC
(p *Profile, isPackaging bool)
profile/qemu.go:335
↓ 7 callers
Function
assertCalls
(t *testing.T, got []capturedCmd, want [][]string)
agent/tcservice_test.go:40
↓ 7 callers
Function
stubNetCommand
stubNetCommand replaces runNetCommand with a recorder for the duration of the test, returning a pointer to the captured invocations.
agent/tcservice_test.go:23
↓ 6 callers
Function
Load
Load decodes a profile and validates it. Unknown keys are rejected, so a misspelled or unsupported setting fails the build instead of being silently i
profile/load.go:27
↓ 6 callers
Method
Warn
(msg string, args ...any)
agent/logging.go:34
↓ 6 callers
Function
drainReads
drainReads calls read until it returns no data, at most maxDrainReads times, and returns everything read: a single console read returns at most one sm
agent/console.go:152
↓ 5 callers
Function
callStarlark
callStarlark accepts inline source or nil to read filename from disk. Arguments and results use JSON-compatible values, preserving integers through YA
profile/starlark.go:86
↓ 5 callers
Method
wireMgmtTap
wireMgmtTap reproduces tc-tap-mgmt-ifup: it keeps the QEMU serial console reachable, mirrors ARP, and redirects management traffic between the mgmt in
agent/tcservice.go:270
↓ 4 callers
Function
NewHandler
NewHandler returns a terminal-aware handler with quoted multiline fields.
logging/handler.go:23
↓ 4 callers
Method
Validate
Validate checks the profile for problems that would otherwise only surface while packaging or running the VM, returning all of them at once.
profile/load.go:48
↓ 4 callers
Function
loadCumulusProfile
(t *testing.T)
profile/cumulus_test.go:17
↓ 4 callers
Method
prepareBuild
(diskImage, profile string)
boxen/build.go:161
↓ 4 callers
Function
prepareCumulusFiles
(t *testing.T)
profile/cumulus_test.go:37
↓ 4 callers
Method
resolveProfile
( profileNameOrFile string, )
boxen/platform.go:17
↓ 4 callers
Method
tee
(level, msg string, args ...any)
agent/logging.go:59
↓ 4 callers
Method
validate
()
profile/load.go:149
↓ 3 callers
Method
Builder
(ctx context.Context, in *BuilderRequest, opts ...grpc.CallOption)
proto/v1/server_grpc.pb.go:32
↓ 3 callers
Method
Check
Check if this Contains lives in b.
profile/common.go:20
↓ 3 callers
Method
Find
Find returns the start and end offsets of the first match of this Contains in b, or nil when there is no match. A literal match is preferred over a pa
profile/common.go:29
↓ 3 callers
Function
GetEnvStrOrDefault
GetEnvStrOrDefault returns the value of the environment variable k or the default d if the value is unset/empty.
util/env.go:14
↓ 3 callers
Method
GetRequest
()
proto/v1/server.pb.go:170
↓ 3 callers
Method
IsManagementPassthroughEnabled
IsManagementPassthroughEnabled resolves the transparent management mode. The CLAB_MGMT_PASSTHROUGH environment var wins over the profile default, allo
profile/virtualmachine.go:155
↓ 3 callers
Function
buildBuilderEnv
(host string, vmConsole bool)
boxen/build.go:201
↓ 3 callers
Function
cleanText
(s string)
logging/handler.go:95
↓ 3 callers
Method
invokeCommand
(ctx context.Context, command string)
agent/command.go:8
↓ 3 callers
Function
loadCommunitySonicProfile
(t *testing.T)
profile/community_sonic_test.go:12
↓ 3 callers
Function
qemuDataNICs
(p *Profile)
profile/qemu.go:392
↓ 3 callers
Method
record
(name string, args ...string)
agent/tcservice_test.go:295
↓ 3 callers
Method
runSteps
runSteps runs the given profile steps against the console in order, stopping at the first failure.
agent/steps.go:13
↓ 3 callers
Method
startInstance
(ctx context.Context, isPackaging bool)
agent/instance.go:19
↓ 3 callers
Function
validateDuration
(field, value string)
profile/load.go:226
↓ 3 callers
Method
watchInstance
watchInstance reports the VM exiting on its own (crash or guest power off) as a run failure, so the node becomes unhealthy and the container exits ins
agent/run.go:304
↓ 3 callers
Method
watchNIC
watchNIC waits for tap (created by QEMU) to appear and runs setup once, then keeps the tc rules in sync with eth appearing/disappearing, re-wiring whe
agent/tcservice.go:85
↓ 2 callers
Method
Build
Build runs the build process -- this is the build process from the users perspective -- i.e. on their laptop.
boxen/build.go:18
↓ 2 callers
Method
Filer
(ctx context.Context, in *FilerRequest, opts ...grpc.CallOption)
proto/v1/server_grpc.pb.go:33
↓ 2 callers
Method
GetData
()
proto/v1/server.pb.go:546
↓ 2 callers
Method
GetDone
()
proto/v1/server.pb.go:553
↓ 2 callers
Method
GetNatPorts
GetNatPorts returns the ports forwarded to the VM in legacy management mode: the profile's natPorts, or the defaults when the profile lists none.
profile/virtualmachine.go:139
↓ 2 callers
Method
GetNicType
GetNicType returns the QEMU NIC model, QEMU_NIC_TYPE overrides the profile's nicType.
profile/virtualmachine.go:148
↓ 2 callers
Method
GetResponse
()
proto/v1/server.pb.go:327
↓ 2 callers
Method
Logger
(ctx context.Context, opts ...grpc.CallOption)
proto/v1/server_grpc.pb.go:31
↓ 2 callers
Method
ResolveDataNICMACs
ResolveDataNICMACs sets the MAC of each data nic: the MAC of the matching container interface when it exists, so the guest uses the MAC containerlab a
profile/qemu.go:411
↓ 2 callers
Method
Send
(response *boxenprotov1.FilerResponse)
boxen/rpcfiler_test.go:22
↓ 2 callers
Method
applyIPv4CIDR
applyIPv4CIDR sets the IPv4 address, network, and prefix-length fields from the given CIDR.
profile/formatters.go:439
↓ 2 callers
Method
applyIPv6CIDR
applyIPv6CIDR sets the IPv6 address, network, and prefix-length fields from the given CIDR.
profile/formatters.go:455
↓ 2 callers
Method
bringMgmtTapUp
bringMgmtTapUp brings the management tap up, sets the MTU, and flushes any IPv6 addresses so periodic traffic from the container itself does not leak
agent/tcservice.go:252
↓ 2 callers
Function
buildBuilderVolumes
()
boxen/build.go:213
↓ 2 callers
Function
buildOpenConsoleCommand
(containerID string)
boxen/build.go:252
↓ 2 callers
Function
cleanAttr
(a slog.Attr)
logging/handler.go:73
↓ 2 callers
Method
closeConsoleConn
(ctx context.Context)
agent/console.go:132
↓ 2 callers
Method
count
(pred func(capturedCmd) bool)
agent/tcservice_test.go:302
↓ 2 callers
Function
defaultManagementFormatters
defaultManagementFormatters returns the default management formatters. It sets the default IPv4 and IPv6 gateways and applies the default CIDRs.
profile/formatters.go:307
↓ 2 callers
Function
dhcpManagementFormatters
()
profile/formatters.go:319
↓ 2 callers
Function
generateMac
(lastOctet int)
profile/qemu.go:460
↓ 2 callers
Function
getIntfMac
(ctx context.Context, intf string)
profile/qemu.go:476
↓ 2 callers
Function
intfWaitTimeout
()
agent/run.go:273
↓ 2 callers
Function
invokeStarlarkF
(fBody string, cmd []string, isPackaging bool)
profile/qemu.go:498
↓ 2 callers
Method
newIndex
(name string)
agent/tcservice_test.go:272
↓ 2 callers
Method
openConsoleConn
(ctx context.Context, logFilename string)
agent/console.go:31
↓ 2 callers
Function
openFile
openFile uses embedded companions for profile names and host files for custom profiles, whose extraFiles paths are made absolute by loadProfileFile.
boxen/rpcfiler.go:73
↓ 2 callers
Method
packageConvertDisk
(ctx context.Context)
agent/package.go:371
↓ 2 callers
Method
packageGetFiles
(ctx context.Context)
agent/package.go:304
↓ 2 callers
Method
packagePreCommands
(ctx context.Context)
agent/package.go:398
↓ 2 callers
Method
packageRequestCompleted
(ctx context.Context)
agent/package.go:192
↓ 2 callers
Function
parseCIDR
parseCIDR parses a CIDR string into its address, network, and prefix-length parts. The prefix length is returned as an int, so callers that need it nu
profile/formatters.go:429
↓ 2 callers
Function
promptCallbackName
(idx int, promptName string)
agent/process.go:16
↓ 2 callers
Function
readFile
readFile returns raw file contents, optionally using a default for a missing file.
profile/files.go:12
↓ 2 callers
Function
resolveFilePath
resolves the file at f -- if f exists, great, if not we check in the same directory that the users root disk is (d).
boxen/rpcfiler.go:94
↓ 2 callers
Method
runPrepareDisk
runPrepareDisk creates the qcow2 overlay the VM writes to, backed by the packaged disk. The packaged disk stays untouched in the image layer, so start
agent/instancestate.go:23
↓ 2 callers
Method
runResolveInstanceUUID
runResolveInstanceUUID sets the VM system UUID: UUID from the environment when set, otherwise the UUID generated by a previous start of this container
agent/instancestate.go:72
↓ 2 callers
Method
runTC
runTC runs a sequence of `tc` invocations, returning on the first failure.
agent/tcservice.go:147
↓ 2 callers
Method
setPresent
setPresent adds or removes an interface; an added interface gets a new index.
agent/tcservice_test.go:252
↓ 2 callers
Method
setupMgmtNIC
setupMgmtNIC plugs the management interface a single time. Unlike data NICs, the management interface is always present and never hotplugged, so there
agent/tcservice.go:214
↓ 2 callers
Function
useRunDisk
useRunDisk points the VM at the per-container overlay instead of the packaged disk. It rewrites every reference to the packaged disk, including path-q
profile/qemu.go:142
↓ 2 callers
Method
wireDataTap
wireDataTap installs the bidirectional tc mirred redirect rules between the container data interface and the VM tap. The ingress qdiscs are recreated,
agent/tcservice.go:188
↓ 2 callers
Method
writeHealth
writeHealth writes the given status string to the health file consulted by the container healthcheck.
agent/health.go:20
↓ 1 callers
Method
Apply
Apply appends this ConfigField's content to the list of qemu commands in `o`, gated by whether the field applies to the current packaging/run phase.
profile/virtualmachine.go:75
↓ 1 callers
Function
ClabIntfName
ClabIntfName returns the containerlab interface name for the given index (e.g. "eth0"), honoring the CLAB_INTF_PREFIX environment variable.
util/env.go:54
↓ 1 callers
Function
ClabIntfPrefix
ClabIntfPrefix returns the containerlab interface name prefix (e.g. "eth"), honoring the CLAB_INTF_PREFIX environment variable when set.
util/env.go:48
↓ 1 callers
Method
Commit
( ctx context.Context, l *slog.Logger, containerID, imageID string, natPorts []boxenprofile.NatPort,
container/container.go:34
↓ 1 callers
Method
Error
()
logging/handler_test.go:58
↓ 1 callers
Method
Exec
( ctx context.Context, l *slog.Logger, cfg *boxencontainertypes.ExecConfig, )
container/container.go:29
↓ 1 callers
Method
Filer
Filer is rpc endpoint for the builder to ask for files to be streamed to it from the server.
boxen/rpcfiler.go:18
↓ 1 callers
Method
GetDisk
()
proto/v1/server.pb.go:412
next →
1–100 of 380, ranked by callers