Thales Maciel
f0668ee598
Introduces the headline feature of the kernel catalog: pulling a kernel
bundle over HTTP without any local build step.
Catalog format (internal/kernelcat/catalog.go):
- Catalog { Version, Entries } + CatEntry { Name, Distro, Arch,
KernelVersion, TarballURL, TarballSHA256, SizeBytes, Description }.
- catalog.json is embedded via go:embed and ships with each banger
binary. It starts empty (Phase 5's CI pipeline will populate it).
- Lookup(name) returns the matching entry or os.ErrNotExist.
Fetch (internal/kernelcat/fetch.go):
- HTTP GET with streaming SHA256 over the response body.
- zstd-decode (github.com/klauspost/compress/zstd) -> tar extract into
<kernelsDir>/<name>/.
- Hardens against path-traversal tarball entries (members whose
normalised path escapes the target dir, and unsafe symlink
targets) and sha256-mismatch downloads; any failure removes the
partially-populated target dir.
- Regular files, directories, and safe symlinks are supported; other
tar types (hardlinks, devices, fifos) are silently skipped.
- After extraction, recomputes sha256 over the on-disk vmlinux and
writes the manifest with Source="pull:<url>".
Daemon methods (internal/daemon/kernels.go):
- KernelPull(ctx, {Name, Force}) - lookup in embedded catalog, refuse
overwrite unless Force, delegate to kernelcat.Fetch.
- KernelCatalog(ctx) - return the embedded catalog annotated per-entry
with whether it has been pulled locally.
RPC: kernel.pull, kernel.catalog dispatch cases.
CLI:
- `banger kernel pull <name> [--force]`.
- `banger kernel list --available` prints the catalog with a
pulled/available STATE column and a human-readable size.
Tests: fetch round-trip (extract + manifest + sha256), sha256 mismatch
rejection with cleanup, missing-vmlinux rejection, path-traversal
rejection, HTTP error propagation, catalog parsing, lookup,
pulled-status reconciliation. All 20 packages green.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
366 lines
11 KiB
Go
366 lines
11 KiB
Go
package api
|
|
|
|
import (
|
|
"time"
|
|
|
|
"banger/internal/model"
|
|
)
|
|
|
|
type Empty struct{}
|
|
|
|
type PingResult struct {
|
|
Status string `json:"status"`
|
|
PID int `json:"pid"`
|
|
WebURL string `json:"web_url,omitempty"`
|
|
Version string `json:"version,omitempty"`
|
|
Commit string `json:"commit,omitempty"`
|
|
BuiltAt string `json:"built_at,omitempty"`
|
|
}
|
|
|
|
type ShutdownResult struct {
|
|
Status string `json:"status"`
|
|
}
|
|
|
|
type VMCreateParams struct {
|
|
Name string `json:"name,omitempty"`
|
|
ImageName string `json:"image_name,omitempty"`
|
|
VCPUCount *int `json:"vcpu_count,omitempty"`
|
|
MemoryMiB *int `json:"memory_mib,omitempty"`
|
|
SystemOverlaySize string `json:"system_overlay_size,omitempty"`
|
|
WorkDiskSize string `json:"work_disk_size,omitempty"`
|
|
NATEnabled bool `json:"nat_enabled,omitempty"`
|
|
NoStart bool `json:"no_start,omitempty"`
|
|
}
|
|
|
|
type VMCreateStatusParams struct {
|
|
ID string `json:"id"`
|
|
}
|
|
|
|
type VMCreateOperation struct {
|
|
ID string `json:"id"`
|
|
VMID string `json:"vm_id,omitempty"`
|
|
VMName string `json:"vm_name,omitempty"`
|
|
Stage string `json:"stage,omitempty"`
|
|
Detail string `json:"detail,omitempty"`
|
|
StartedAt time.Time `json:"started_at,omitempty"`
|
|
UpdatedAt time.Time `json:"updated_at,omitempty"`
|
|
Done bool `json:"done"`
|
|
Success bool `json:"success"`
|
|
Error string `json:"error,omitempty"`
|
|
VM *model.VMRecord `json:"vm,omitempty"`
|
|
}
|
|
|
|
type VMCreateBeginResult struct {
|
|
Operation VMCreateOperation `json:"operation"`
|
|
}
|
|
|
|
type VMCreateStatusResult struct {
|
|
Operation VMCreateOperation `json:"operation"`
|
|
}
|
|
|
|
type ImageBuildStatusParams struct {
|
|
ID string `json:"id"`
|
|
}
|
|
|
|
type ImageBuildOperation struct {
|
|
ID string `json:"id"`
|
|
ImageID string `json:"image_id,omitempty"`
|
|
ImageName string `json:"image_name,omitempty"`
|
|
Stage string `json:"stage,omitempty"`
|
|
Detail string `json:"detail,omitempty"`
|
|
BuildLogPath string `json:"build_log_path,omitempty"`
|
|
StartedAt time.Time `json:"started_at,omitempty"`
|
|
UpdatedAt time.Time `json:"updated_at,omitempty"`
|
|
Done bool `json:"done"`
|
|
Success bool `json:"success"`
|
|
Error string `json:"error,omitempty"`
|
|
Image *model.Image `json:"image,omitempty"`
|
|
}
|
|
|
|
type ImageBuildBeginResult struct {
|
|
Operation ImageBuildOperation `json:"operation"`
|
|
}
|
|
|
|
type ImageBuildStatusResult struct {
|
|
Operation ImageBuildOperation `json:"operation"`
|
|
}
|
|
|
|
type VMRefParams struct {
|
|
IDOrName string `json:"id_or_name"`
|
|
}
|
|
|
|
type VMKillParams struct {
|
|
IDOrName string `json:"id_or_name"`
|
|
Signal string `json:"signal,omitempty"`
|
|
}
|
|
|
|
type VMSetParams struct {
|
|
IDOrName string `json:"id_or_name"`
|
|
VCPUCount *int `json:"vcpu_count,omitempty"`
|
|
MemoryMiB *int `json:"memory_mib,omitempty"`
|
|
WorkDiskSize string `json:"work_disk_size,omitempty"`
|
|
NATEnabled *bool `json:"nat_enabled,omitempty"`
|
|
}
|
|
|
|
type VMListResult struct {
|
|
VMs []model.VMRecord `json:"vms"`
|
|
}
|
|
|
|
type VMShowResult struct {
|
|
VM model.VMRecord `json:"vm"`
|
|
}
|
|
|
|
type VMStatsResult struct {
|
|
VM model.VMRecord `json:"vm"`
|
|
Stats model.VMStats `json:"stats"`
|
|
}
|
|
|
|
type VMLogsResult struct {
|
|
LogPath string `json:"log_path"`
|
|
}
|
|
|
|
type VMSSHResult struct {
|
|
Name string `json:"name"`
|
|
GuestIP string `json:"guest_ip"`
|
|
}
|
|
|
|
type VMHealthResult struct {
|
|
Name string `json:"name"`
|
|
Healthy bool `json:"healthy"`
|
|
}
|
|
|
|
type VMPingResult struct {
|
|
Name string `json:"name"`
|
|
Alive bool `json:"alive"`
|
|
}
|
|
|
|
type VMPort struct {
|
|
Proto string `json:"proto"`
|
|
BindAddress string `json:"bind_address,omitempty"`
|
|
Port int `json:"port"`
|
|
PID int `json:"pid,omitempty"`
|
|
Process string `json:"process,omitempty"`
|
|
Command string `json:"command,omitempty"`
|
|
Endpoint string `json:"endpoint,omitempty"`
|
|
}
|
|
|
|
type VMPortsResult struct {
|
|
Name string `json:"name"`
|
|
DNSName string `json:"dns_name,omitempty"`
|
|
Ports []VMPort `json:"ports"`
|
|
}
|
|
|
|
type GuestSessionStartParams struct {
|
|
VMIDOrName string `json:"vm_id_or_name"`
|
|
Name string `json:"name,omitempty"`
|
|
Command string `json:"command"`
|
|
Args []string `json:"args,omitempty"`
|
|
CWD string `json:"cwd,omitempty"`
|
|
Env map[string]string `json:"env,omitempty"`
|
|
StdinMode string `json:"stdin_mode,omitempty"`
|
|
Tags map[string]string `json:"tags,omitempty"`
|
|
RequiredCommands []string `json:"required_commands,omitempty"`
|
|
}
|
|
|
|
type GuestSessionRefParams struct {
|
|
VMIDOrName string `json:"vm_id_or_name"`
|
|
SessionIDOrName string `json:"session_id_or_name"`
|
|
}
|
|
|
|
type GuestSessionLogsParams struct {
|
|
VMIDOrName string `json:"vm_id_or_name"`
|
|
SessionIDOrName string `json:"session_id_or_name"`
|
|
Stream string `json:"stream,omitempty"`
|
|
TailLines int `json:"tail_lines,omitempty"`
|
|
}
|
|
|
|
type GuestSessionAttachBeginParams struct {
|
|
VMIDOrName string `json:"vm_id_or_name"`
|
|
SessionIDOrName string `json:"session_id_or_name"`
|
|
}
|
|
|
|
type GuestSessionListResult struct {
|
|
Sessions []model.GuestSession `json:"sessions"`
|
|
}
|
|
|
|
type GuestSessionShowResult struct {
|
|
Session model.GuestSession `json:"session"`
|
|
}
|
|
|
|
type GuestSessionLogsResult struct {
|
|
Session model.GuestSession `json:"session"`
|
|
Stream string `json:"stream"`
|
|
Path string `json:"path,omitempty"`
|
|
Content string `json:"content,omitempty"`
|
|
}
|
|
|
|
type GuestSessionAttachBeginResult struct {
|
|
Session model.GuestSession `json:"session"`
|
|
AttachID string `json:"attach_id"`
|
|
TransportKind string `json:"transport_kind"`
|
|
TransportTarget string `json:"transport_target"`
|
|
SocketPath string `json:"socket_path,omitempty"`
|
|
StreamFormat string `json:"stream_format"`
|
|
}
|
|
|
|
type GuestSessionSendParams struct {
|
|
VMIDOrName string `json:"vm_id_or_name"`
|
|
SessionIDOrName string `json:"session_id_or_name"`
|
|
Payload []byte `json:"payload"`
|
|
}
|
|
|
|
type GuestSessionSendResult struct {
|
|
Session model.GuestSession `json:"session"`
|
|
BytesWritten int `json:"bytes_written"`
|
|
}
|
|
|
|
type WorkspaceExportParams struct {
|
|
IDOrName string `json:"id_or_name"`
|
|
GuestPath string `json:"guest_path,omitempty"`
|
|
BaseCommit string `json:"base_commit,omitempty"`
|
|
}
|
|
|
|
type WorkspaceExportResult struct {
|
|
GuestPath string `json:"guest_path"`
|
|
BaseCommit string `json:"base_commit"`
|
|
Patch []byte `json:"patch"`
|
|
ChangedFiles []string `json:"changed_files"`
|
|
HasChanges bool `json:"has_changes"`
|
|
}
|
|
|
|
type VMWorkspacePrepareParams struct {
|
|
IDOrName string `json:"id_or_name"`
|
|
SourcePath string `json:"source_path"`
|
|
GuestPath string `json:"guest_path,omitempty"`
|
|
Branch string `json:"branch,omitempty"`
|
|
From string `json:"from,omitempty"`
|
|
Mode string `json:"mode,omitempty"`
|
|
ReadOnly bool `json:"readonly,omitempty"`
|
|
}
|
|
|
|
type VMWorkspacePrepareResult struct {
|
|
Workspace model.WorkspacePrepareResult `json:"workspace"`
|
|
}
|
|
|
|
type ImageBuildParams struct {
|
|
Name string `json:"name,omitempty"`
|
|
FromImage string `json:"from_image,omitempty"`
|
|
Size string `json:"size,omitempty"`
|
|
KernelPath string `json:"kernel_path,omitempty"`
|
|
InitrdPath string `json:"initrd_path,omitempty"`
|
|
ModulesDir string `json:"modules_dir,omitempty"`
|
|
Docker bool `json:"docker,omitempty"`
|
|
}
|
|
|
|
type ImageRegisterParams struct {
|
|
Name string `json:"name,omitempty"`
|
|
RootfsPath string `json:"rootfs_path,omitempty"`
|
|
WorkSeedPath string `json:"work_seed_path,omitempty"`
|
|
KernelPath string `json:"kernel_path,omitempty"`
|
|
InitrdPath string `json:"initrd_path,omitempty"`
|
|
ModulesDir string `json:"modules_dir,omitempty"`
|
|
KernelRef string `json:"kernel_ref,omitempty"`
|
|
Docker bool `json:"docker,omitempty"`
|
|
}
|
|
|
|
type ImageRefParams struct {
|
|
IDOrName string `json:"id_or_name"`
|
|
}
|
|
|
|
type ImageListResult struct {
|
|
Images []model.Image `json:"images"`
|
|
}
|
|
|
|
type ImageShowResult struct {
|
|
Image model.Image `json:"image"`
|
|
}
|
|
|
|
type KernelEntry struct {
|
|
Name string `json:"name"`
|
|
Distro string `json:"distro,omitempty"`
|
|
Arch string `json:"arch,omitempty"`
|
|
KernelVersion string `json:"kernel_version,omitempty"`
|
|
SHA256 string `json:"sha256,omitempty"`
|
|
Source string `json:"source,omitempty"`
|
|
ImportedAt string `json:"imported_at,omitempty"`
|
|
KernelPath string `json:"kernel_path,omitempty"`
|
|
InitrdPath string `json:"initrd_path,omitempty"`
|
|
ModulesDir string `json:"modules_dir,omitempty"`
|
|
}
|
|
|
|
type KernelListResult struct {
|
|
Entries []KernelEntry `json:"entries"`
|
|
}
|
|
|
|
type KernelRefParams struct {
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
type KernelShowResult struct {
|
|
Entry KernelEntry `json:"entry"`
|
|
}
|
|
|
|
type KernelImportParams struct {
|
|
Name string `json:"name"`
|
|
FromDir string `json:"from_dir"`
|
|
Distro string `json:"distro,omitempty"`
|
|
Arch string `json:"arch,omitempty"`
|
|
}
|
|
|
|
type KernelPullParams struct {
|
|
Name string `json:"name"`
|
|
Force bool `json:"force,omitempty"`
|
|
}
|
|
|
|
type KernelCatalogEntry struct {
|
|
Name string `json:"name"`
|
|
Distro string `json:"distro,omitempty"`
|
|
Arch string `json:"arch,omitempty"`
|
|
KernelVersion string `json:"kernel_version,omitempty"`
|
|
SizeBytes int64 `json:"size_bytes,omitempty"`
|
|
Description string `json:"description,omitempty"`
|
|
Pulled bool `json:"pulled"`
|
|
}
|
|
|
|
type KernelCatalogResult struct {
|
|
Entries []KernelCatalogEntry `json:"entries"`
|
|
}
|
|
|
|
type SudoStatus struct {
|
|
Available bool `json:"available"`
|
|
Command string `json:"command,omitempty"`
|
|
Error string `json:"error,omitempty"`
|
|
}
|
|
|
|
type HostSummary struct {
|
|
CPUCount int `json:"cpu_count"`
|
|
TotalMemoryBytes int64 `json:"total_memory_bytes"`
|
|
StateFilesystemTotalBytes int64 `json:"state_filesystem_total_bytes"`
|
|
StateFilesystemFreeBytes int64 `json:"state_filesystem_free_bytes"`
|
|
}
|
|
|
|
type BangerSummary struct {
|
|
ImageCount int `json:"image_count"`
|
|
ManagedImageCount int `json:"managed_image_count"`
|
|
VMCount int `json:"vm_count"`
|
|
RunningVMCount int `json:"running_vm_count"`
|
|
ConfiguredVCPUCount int `json:"configured_vcpu_count"`
|
|
ConfiguredMemoryBytes int64 `json:"configured_memory_bytes"`
|
|
ConfiguredDiskBytes int64 `json:"configured_disk_bytes"`
|
|
UsedSystemOverlayBytes int64 `json:"used_system_overlay_bytes"`
|
|
UsedWorkDiskBytes int64 `json:"used_work_disk_bytes"`
|
|
RunningCPUPercent float64 `json:"running_cpu_percent"`
|
|
RunningRSSBytes int64 `json:"running_rss_bytes"`
|
|
RunningVSZBytes int64 `json:"running_vsz_bytes"`
|
|
}
|
|
|
|
type DashboardSummary struct {
|
|
GeneratedAt time.Time `json:"generated_at"`
|
|
Host HostSummary `json:"host"`
|
|
Sudo SudoStatus `json:"sudo"`
|
|
Banger BangerSummary `json:"banger"`
|
|
}
|
|
|
|
type DashboardSummaryResult struct {
|
|
Summary DashboardSummary `json:"summary"`
|
|
}
|