tree

package

v0.1.43 Latest Latest Go to latest Published: Jun 3, 2026 License: Apache-2.0 Imports: 28 Imported by: 0

Details

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

Repository

github.com/platform-engineering-labs/orbital

Links

Open Source Insights

Documentation ¶

Index ¶

func CreateDefault(root string) error
type Config
- func Load(path string) (*Config, error)
- func (c *Config) Platform() *platform.Platform
- func (c *Config) Repository(name string) (*ops.Repository, error)
type Entry
type Tree
- func New(log *slog.Logger, root string, t Type, cfg *Config) (Tree, error)
type TreeDynamic
type TreeEmbedded
type Type

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateDefault ¶

func CreateDefault(root string) error

Types ¶

type Config ¶

type Config struct {
	OS   os.OS     `pkl:"os"`
	Arch arch.Arch `pkl:"arch"`

	Security security.Mode `pkl:"security"`

	Repositories []ops.Repository `pkl:"repositories"`
}

func Load ¶

func Load(path string) (*Config, error)

func (*Config) Platform ¶

func (c *Config) Platform() *platform.Platform

func (*Config) Repository ¶

func (c *Config) Repository(name string) (*ops.Repository, error)

type Entry ¶

type Entry struct {
	Name     string
	Path     string
	Platform *platform.Platform

	Current    bool
	Privileged bool
}

type Tree ¶

type Tree interface {
	Cache() *cache.Cache
	Config() *Config
	Current() *Entry
	Destroy(name string) (*Entry, error)
	Get(name string) (*Entry, error)
	Init(name string, pltfrm *platform.Platform, force bool) (*Entry, error)
	Ready() bool
	List() ([]*Entry, error)
	Lock() error
	Unlock() error
	Pki() *pki.Pki
	Pool(platforms []*platform.Platform, empty bool, repos ...*ops.Repository) (*ops.Pool, error)
	RepoLoad(platforms []*platform.Platform, repo *ops.Repository, all bool) error
	Security() security.Security
	State() *state.State
	StateToRepo() (*ops.Repository, error)
	Switch(string) error
}

func New ¶

func New(log *slog.Logger, root string, t Type, cfg *Config) (Tree, error)

type TreeDynamic ¶

type TreeDynamic struct {
	*slog.Logger
	// contains filtered or unexported fields
}

func (*TreeDynamic) Cache ¶

func (t *TreeDynamic) Cache() *cache.Cache

func (*TreeDynamic) Config ¶

func (t *TreeDynamic) Config() *Config

func (*TreeDynamic) Current ¶

func (t *TreeDynamic) Current() *Entry

func (*TreeDynamic) Destroy ¶

func (t *TreeDynamic) Destroy(name string) (*Entry, error)

func (*TreeDynamic) Get ¶

func (t *TreeDynamic) Get(name string) (*Entry, error)

func (*TreeDynamic) Init ¶

func (t *TreeDynamic) Init(name string, pltfrm *platform.Platform, force bool) (*Entry, error)

func (*TreeDynamic) List ¶

func (t *TreeDynamic) List() ([]*Entry, error)

func (*TreeDynamic) Lock ¶

func (t *TreeDynamic) Lock() error

func (*TreeDynamic) Pki ¶

func (t *TreeDynamic) Pki() *pki.Pki

func (*TreeDynamic) Pool ¶

func (t *TreeDynamic) Pool(platforms []*platform.Platform, empty bool, repos ...*ops.Repository) (*ops.Pool, error)

func (*TreeDynamic) Ready ¶

func (t *TreeDynamic) Ready() bool

func (*TreeDynamic) RepoLoad ¶

func (t *TreeDynamic) RepoLoad(platforms []*platform.Platform, repo *ops.Repository, all bool) error

func (*TreeDynamic) Security ¶

func (t *TreeDynamic) Security() security.Security

func (*TreeDynamic) State ¶

func (t *TreeDynamic) State() *state.State

func (*TreeDynamic) StateToRepo ¶

func (t *TreeDynamic) StateToRepo() (*ops.Repository, error)

func (*TreeDynamic) Switch ¶

func (t *TreeDynamic) Switch(name string) error

func (*TreeDynamic) Unlock ¶

func (t *TreeDynamic) Unlock() error

type TreeEmbedded ¶

type TreeEmbedded struct {
	*slog.Logger
	// contains filtered or unexported fields
}

func (*TreeEmbedded) Cache ¶

func (t *TreeEmbedded) Cache() *cache.Cache

func (*TreeEmbedded) Config ¶

func (t *TreeEmbedded) Config() *Config

func (*TreeEmbedded) Current ¶

func (t *TreeEmbedded) Current() *Entry

func (*TreeEmbedded) Destroy ¶

func (t *TreeEmbedded) Destroy(name string) (*Entry, error)

func (*TreeEmbedded) Get ¶

func (t *TreeEmbedded) Get(name string) (*Entry, error)

func (*TreeEmbedded) Init ¶

func (t *TreeEmbedded) Init(_ string, _ *platform.Platform, force bool) (*Entry, error)

func (*TreeEmbedded) List ¶

func (t *TreeEmbedded) List() ([]*Entry, error)

func (*TreeEmbedded) Lock ¶

func (t *TreeEmbedded) Lock() error

func (*TreeEmbedded) Pki ¶

func (t *TreeEmbedded) Pki() *pki.Pki

func (*TreeEmbedded) Pool ¶

func (t *TreeEmbedded) Pool(platforms []*platform.Platform, empty bool, repos ...*ops.Repository) (*ops.Pool, error)

func (*TreeEmbedded) Ready ¶

func (t *TreeEmbedded) Ready() bool

func (*TreeEmbedded) RepoLoad ¶

func (t *TreeEmbedded) RepoLoad(platforms []*platform.Platform, repo *ops.Repository, all bool) error

func (*TreeEmbedded) Security ¶

func (t *TreeEmbedded) Security() security.Security

func (*TreeEmbedded) State ¶

func (t *TreeEmbedded) State() *state.State

func (*TreeEmbedded) StateToRepo ¶

func (t *TreeEmbedded) StateToRepo() (*ops.Repository, error)

func (*TreeEmbedded) Switch ¶

func (t *TreeEmbedded) Switch(_ string) error

func (*TreeEmbedded) Unlock ¶

func (t *TreeEmbedded) Unlock() error

type Type ¶

type Type string

const (
	Dynamic  Type = "dynamic"
	Embedded Type = "embedded"
	Root     Type = "root"
)

Source Files ¶

View all Source files

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