Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/carlmontanari/boxen
/ types & classes
Types & classes
58 in github.com/carlmontanari/boxen
⨍
Functions
380
◇
Types & classes
58
Struct
Agent
Agent is process that runs the container half of things for boxen -- its the thing that the main boxen process talks with during the packaging process
agent/agent.go:22
Struct
Boxen
Boxen is the primary actor in the boxen process -- it is the thing that the cli kicks off for both packaging from a user perspective. It communicates
boxen/boxen.go:16
Interface
BoxenServiceClient
BoxenServiceClient is the client API for BoxenService service. For semantics around ctx use and closing/ending streaming RPCs, please refer to https:
proto/v1/server_grpc.pb.go:30
Interface
BoxenServiceServer
BoxenServiceServer is the server API for BoxenService service. All implementations must embed UnimplementedBoxenServiceServer for forward compatibilit
proto/v1/server_grpc.pb.go:89
Struct
BuilderRequest
Builder RPC
proto/v1/server.pb.go:126
Struct
BuilderRequest_PackageCompleteRequest
proto/v1/server.pb.go:199
Struct
BuilderRequest_PackageInfoRequest
proto/v1/server.pb.go:195
Struct
BuilderResponse
proto/v1/server.pb.go:283
Struct
BuilderResponse_PackageCompleteResponse
proto/v1/server.pb.go:356
Struct
BuilderResponse_PackageInfoResponse
proto/v1/server.pb.go:352
Struct
Contains
Contains holds some fields that help us determine if we should match on some output.
profile/common.go:9
Struct
ExecConfig
ExecConfig is a config struct passed to the runtime interface's Exec method.
container/types/run.go:16
Struct
FilerRequest
Filer RPC
proto/v1/server.pb.go:458
Struct
FilerResponse
proto/v1/server.pb.go:505
Struct
Formatters
Formatters holds the values available for Go template interpolation in profile content.
profile/formatters.go:32
Struct
Handler
Handler formats logs with Charm and cleans terminal control characters for display.
logging/handler.go:18
Struct
LoggerRequest
Loger RPC
proto/v1/server.pb.go:24
Struct
LoggerResponse
proto/v1/server.pb.go:87
Struct
NatPort
NatPort represents a single tcp or udp nat port.
profile/virtualmachine.go:100
TypeAlias
NatType
NatType is an enum-ish value for the type of NAT port -- tcp or udp.
profile/virtualmachine.go:91
Struct
PackageCompleteRequest
proto/v1/server.pb.go:245
Struct
PackageCompleteResponse
proto/v1/server.pb.go:419
Struct
PackageInfoRequest
proto/v1/server.pb.go:207
Struct
PackageInfoResponse
proto/v1/server.pb.go:364
Struct
Packaging
Packaging holds info about how we package an instance.
profile/packaging.go:4
Struct
Profile
Profile holds information about how to package/run a virtual machine in the containerlab compatible image.
profile/profile.go:5
Struct
Prompt
Prompt defines how we match on a prompt and what we respond to it.
profile/common.go:87
Struct
QemuConfigField
QemuConfigField represents an extra qemu arg -- it holds the actual arg(s) to pass and some flags to define if it should be at packaging, runtime, or
profile/virtualmachine.go:67
Struct
QemuConfigVal
QemuConfigVal represents an extra string to add to the qemu command.
profile/virtualmachine.go:86
Struct
Run
Run holds info about how to run a packaged instance.
profile/run.go:4
Struct
RunConfig
RunConfig is a config struct passed to the runtime interface's Run method.
container/types/run.go:4
Interface
Runtime
Runtime is the interface a container runtime needs to satisfy to work with boxen.
container/container.go:23
Struct
Runtime
Runtime is a thin wrapper around cmd.Exec for handling docker-related tasks for boxen.
container/docker/docker.go:8
TypeAlias
RuntimeKind
RuntimeKind is an enum-ish for the supported container runtimes, for now its just docker.
container/container.go:15
Struct
Step
Step represents a step during a package/run process.
profile/common.go:69
Struct
StepPrompts
StepPrompts is a step that lets us handle some prompt(s) from a device.
profile/common.go:78
Struct
StepReadUntil
StepReadUntil defines how we read until some output on the terminal.
profile/common.go:104
TypeAlias
StepType
StepType is a packaging/run step type enum-ish thing.
profile/common.go:58
Struct
StepWait
StepWait tells the agent to wait during a package/run.
profile/common.go:135
Struct
StepWrite
StepWrite holds things we want to write to the terminal during a package/run.
profile/common.go:111
Struct
UnimplementedBoxenServiceServer
UnimplementedBoxenServiceServer must be embedded to have forward compatible implementations. NOTE: this should be embedded by value instead of pointe
proto/v1/server_grpc.pb.go:101
Interface
UnsafeBoxenServiceServer
UnsafeBoxenServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added meth
proto/v1/server_grpc.pb.go:118
Struct
VirtualMachine
VirtualMachine defines the qemu settings/profile for an endpoint, this will generally come from yaml "profile" manifests that we load or users provide
profile/virtualmachine.go:13
Struct
boxenServiceClient
proto/v1/server_grpc.pb.go:36
Struct
capturedCmd
agent/tcservice_test.go:16
Struct
consoleTestError
logging/handler_test.go:56
Struct
fakeNet
fakeNet is a concurrency-safe stand-in for the host network state used to drive watchNIC transitions deterministically.
agent/tcservice_test.go:243
TypeAlias
ipAddressShowOutput
profile/formatters.go:79
TypeAlias
ipLinkShowOutput
profile/qemu.go:472
TypeAlias
ipRouteShowDefaultOutput
profile/formatters.go:88
Interface
isBuilderRequest_Request
proto/v1/server.pb.go:191
Interface
isBuilderResponse_Response
proto/v1/server.pb.go:348
Struct
managementFormatters
profile/formatters.go:46
Struct
starlarkModule
profile/starlark.go:15
Struct
testCumulusLane
profile/cumulus_test.go:32
Struct
testFilerStream
boxen/rpcfiler_test.go:15
Struct
wrappedSlogger
agent/logging.go:12
Struct
x
proto/v1/server.pb.go:818