resourceapply

package

v0.4.4 Latest Latest Go to latest Published: Aug 9, 2026 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SecondStack-AI/SecondBox

Links

Open Source Insights

Documentation ¶

Overview ¶

Package resourceapply checks and converges declarative SecondBox resources.

Index ¶

Constants
func Encode(document Document) ([]byte, error)
func SpecDigest(spec secondboxclient.ProfileRevisionSpec) (string, error)
type Action
type Client
type Document
- func Decode(data []byte) (Document, error)
- func (document Document) Validate() error
type Profile
type ProfileRevision
type Report
- func Apply(ctx context.Context, client Client, document Document) (Report, error)
- func Check(ctx context.Context, client Client, document Document) (Report, error)
type Result
type RunnerPool

Constants ¶

View Source

const SchemaVersion = "secondbox.resources/v1"

Variables ¶

This section is empty.

Functions ¶

func Encode ¶

func Encode(document Document) ([]byte, error)

func SpecDigest ¶

func SpecDigest(spec secondboxclient.ProfileRevisionSpec) (string, error)

Types ¶

type Action ¶

type Action string

const (
	ActionCreate Action = "create"
	ActionUpdate Action = "update"
	ActionAppend Action = "append"
	ActionNoop   Action = "noop"
)

type Client ¶

type Client interface {
	GetRunnerPool(context.Context, secondboxclient.ProfileName) (secondboxclient.RunnerPool, error)
	CreateRunnerPool(context.Context, secondboxclient.CreateRunnerPoolRequest) (secondboxclient.RunnerPool, error)
	UpdateRunnerPool(context.Context, secondboxclient.ProfileName, int64, secondboxclient.UpdateRunnerPoolRequest) (secondboxclient.RunnerPool, error)
	GetProfile(context.Context, secondboxclient.ProfileName) (secondboxclient.Profile, error)
	CreateProfile(context.Context, secondboxclient.CreateProfileRequest, string) (secondboxclient.Profile, error)
	ReviseProfile(context.Context, secondboxclient.ProfileName, int64, secondboxclient.ReviseProfileRequest, string) (secondboxclient.Profile, error)
}

Client is the high-level Go SDK surface used by both CLI and deployment tooling.

type Document ¶

type Document struct {
	SchemaVersion string       `json:"schemaVersion"`
	RunnerPools   []RunnerPool `json:"runnerPools"`
	Profiles      []Profile    `json:"profiles"`
}

Document is a non-secret desired-state document. Absence never means delete.

func Decode ¶

func Decode(data []byte) (Document, error)

func (Document) Validate ¶

func (document Document) Validate() error

type Profile ¶

type Profile struct {
	Name      string            `json:"name"`
	Revisions []ProfileRevision `json:"revisions"`
}

type ProfileRevision ¶

type ProfileRevision struct {
	Number     int64                               `json:"number"`
	SpecDigest string                              `json:"specDigest"`
	Spec       secondboxclient.ProfileRevisionSpec `json:"spec"`
}

type Report ¶

type Report struct {
	SchemaVersion string   `json:"schemaVersion"`
	Applied       bool     `json:"applied"`
	Results       []Result `json:"results"`
}

func Apply ¶

func Apply(ctx context.Context, client Client, document Document) (Report, error)

func Check ¶

func Check(ctx context.Context, client Client, document Document) (Report, error)

type Result ¶

type Result struct {
	Kind         string `json:"kind"`
	Name         string `json:"name"`
	Action       Action `json:"action"`
	FromRevision int64  `json:"fromRevision,omitempty"`
	ToRevision   int64  `json:"toRevision,omitempty"`
}

type RunnerPool ¶

type RunnerPool struct {
	Name           string                                 `json:"name"`
	Architectures  secondboxclient.RunnerArchitectureList `json:"architectures"`
	Capabilities   secondboxclient.RunnerCapabilityList   `json:"capabilities"`
	CapacityPolicy secondboxclient.RunnerCapacityPolicy   `json:"capacityPolicy"`
	State          secondboxclient.RunnerPoolState        `json:"state"`
	MutableFields  []string                               `json:"mutableFields"`
}

Source Files ¶

View all Source files

resourceapply.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL