executor

Documentation

Index

• type BuildFunc
• type Derivation
• type DerivationOutput
• type EvalFunc
• type Executor
  • func NewNixDarwinFlake() (e Executor, err error)
  • func NewNixOSFlake() (e Executor, err error)
  • func NewNixOSNix() (e Executor, err error)
• type NixFlakeLocal
  • func NewNixFlakeExecutor(systemAttr string) (*NixFlakeLocal, error)
  • func (n *NixFlakeLocal) Build(ctx context.Context, drvPath string) (err error)
  • func (n *NixFlakeLocal) Deploy(ctx context.Context, outPath, operation string, profilePaths []string) (needToRestartComin bool, profilePath string, err error)
  • func (n *NixFlakeLocal) Eval(ctx context.Context, ...) (drvPath string, outPath string, machineId string, err error)
  • func (n *NixFlakeLocal) IsStorePathExist(storePath string) bool
  • func (n *NixFlakeLocal) List(flakeUrl string) (hosts []string, err error)
  • func (n *NixFlakeLocal) NeedToReboot(outPath, operation string) bool
  • func (n *NixFlakeLocal) ReadMachineId() (string, error)
  • func (n *NixFlakeLocal) ShowDerivation(ctx context.Context, flakeUrl, hostname string) (drvPath string, outPath string, err error)
• type NixLocal
  • func NewNixExecutor() (*NixLocal, error)
  • func (n *NixLocal) Build(ctx context.Context, drvPath string) (err error)
  • func (n *NixLocal) Deploy(ctx context.Context, outPath, operation string, profilePaths []string) (needToRestartComin bool, profilePath string, err error)
  • func (n *NixLocal) Eval(ctx context.Context, ...) (drvPath string, outPath string, machineId string, err error)
  • func (n *NixLocal) IsStorePathExist(storePath string) bool
  • func (n *NixLocal) NeedToReboot(outPath, operation string) bool
  • func (n *NixLocal) ReadMachineId() (string, error)
• type Output
• type Path
• type Show

Types

type BuildFunc

type BuildFunc func(ctx context.Context, drvPath string) error

type Derivation

type Derivation struct {
	Outputs Output `json:"outputs"`
}

type DerivationOutput

type DerivationOutput struct {
	Version     int                   `json:"version"`
	Derivations map[string]Derivation `json:"derivations"`
}

type EvalFunc

type EvalFunc func(ctx context.Context, repositoryPath, repositorySubdir, commitId, systemAttr, hostname string, submodules bool) (drvPath string, outPath string, machineId string, err error)

type Executor

type Executor interface {
	Eval(ctx context.Context, repositoryPath, repositorySubdir, commitId, systemAttr, hostname string, submodules bool) (drvPath string, outPath string, machineId string, err error)
	Build(ctx context.Context, drvPath string) (err error)
	Deploy(ctx context.Context, outPath, operation string, profilePaths []string) (needToRestartComin bool, profilePath string, err error)
	NeedToReboot(outPath, operation string) bool
	ReadMachineId() (string, error)
	// IsStorePathExist returns true if a storepath exists. This
	// is used to detect if a build will be required or not.
	IsStorePathExist(string) bool
}

Executor contains the function used by comin to actually do actions on the host. This allows us to abstract the way Nix expression are evaluated, built and deployed. This could be for instance used by a Garnix implementation (such as proposed in https://github.com/nlewo/comin/pull/74)

func NewNixDarwinFlake

func NewNixDarwinFlake() (e Executor, err error)

func NewNixOSFlake

func NewNixOSFlake() (e Executor, err error)

func NewNixOSNix

func NewNixOSNix() (e Executor, err error)

type NixFlakeLocal

type NixFlakeLocal struct {
	// contains filtered or unexported fields
}

func NewNixFlakeExecutor

func NewNixFlakeExecutor(systemAttr string) (*NixFlakeLocal, error)

func (*NixFlakeLocal) Build

func (n *NixFlakeLocal) Build(ctx context.Context, drvPath string) (err error)

func (*NixFlakeLocal) Deploy

func (n *NixFlakeLocal) Deploy(ctx context.Context, outPath, operation string, profilePaths []string) (needToRestartComin bool, profilePath string, err error)

func (*NixFlakeLocal) Eval

func (n *NixFlakeLocal) Eval(ctx context.Context, repositoryPath, repositorySubdir, commitId, systemAttr, hostname string, submodules bool) (drvPath string, outPath string, machineId string, err error)

func (*NixFlakeLocal) IsStorePathExist

func (n *NixFlakeLocal) IsStorePathExist(storePath string) bool

func (*NixFlakeLocal) List

func (n *NixFlakeLocal) List(flakeUrl string) (hosts []string, err error)

func (*NixFlakeLocal) NeedToReboot

func (n *NixFlakeLocal) NeedToReboot(outPath, operation string) bool

func (*NixFlakeLocal) ReadMachineId

func (n *NixFlakeLocal) ReadMachineId() (string, error)

func (*NixFlakeLocal) ShowDerivation

func (n *NixFlakeLocal) ShowDerivation(ctx context.Context, flakeUrl, hostname string) (drvPath string, outPath string, err error)

type NixLocal

type NixLocal struct{}

func NewNixExecutor

func NewNixExecutor() (*NixLocal, error)

func (*NixLocal) Build

func (n *NixLocal) Build(ctx context.Context, drvPath string) (err error)

func (*NixLocal) Deploy

func (n *NixLocal) Deploy(ctx context.Context, outPath, operation string, profilePaths []string) (needToRestartComin bool, profilePath string, err error)

func (*NixLocal) Eval

func (n *NixLocal) Eval(ctx context.Context, repositoryPath, repositorySubdir, commitId, systemAttr, hostname string, submodules bool) (drvPath string, outPath string, machineId string, err error)

func (*NixLocal) IsStorePathExist

func (n *NixLocal) IsStorePathExist(storePath string) bool

func (*NixLocal) NeedToReboot

func (n *NixLocal) NeedToReboot(outPath, operation string) bool

func (*NixLocal) ReadMachineId

func (n *NixLocal) ReadMachineId() (string, error)

type Output

type Output struct {
	Out Path `json:"out"`
}

type Path

type Path struct {
	Path string `json:"path"`
}

type Show

type Show struct {
	NixosConfigurations  map[string]struct{} `json:"nixosConfigurations"`
	DarwinConfigurations map[string]struct{} `json:"darwinConfigurations"`
}