888 lines
30 KiB
Go
888 lines
30 KiB
Go
// Code generated by seatgen from the seat definitions; DO NOT EDIT.
|
|
|
|
// Package nodeengine is the contract of the seat "node-engine", defined whole (seats/node-engine/seat.json): The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 §3, §4): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token.
|
|
package nodeengine
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"errors"
|
|
"strings"
|
|
)
|
|
|
|
// Seat is the seat's name.
|
|
const Seat = "node-engine"
|
|
|
|
const (
|
|
VerbHandOver = "hand-over"
|
|
VerbAccessAct = "access-act"
|
|
VerbJudgeDirectories = "judge-directories"
|
|
VerbSetuidSearch = "setuid-search"
|
|
VerbRootFree = "root-free"
|
|
VerbActs = "acts"
|
|
VerbPackages = "packages"
|
|
VerbComposition = "composition"
|
|
VerbCompose = "compose"
|
|
VerbComposeCandidate = "compose-candidate"
|
|
VerbManifestReads = "manifest-reads"
|
|
)
|
|
|
|
const (
|
|
EventAsked = "asked"
|
|
EventDone = "done"
|
|
EventRefused = "refused"
|
|
EventManifestReadsChanged = "manifest-reads-changed"
|
|
)
|
|
|
|
// Verbs is every verb the seat serves, in its definition's order: a new copy each call.
|
|
func Verbs() []string {
|
|
return []string{VerbHandOver, VerbAccessAct, VerbJudgeDirectories, VerbSetuidSearch, VerbRootFree, VerbActs, VerbPackages, VerbComposition, VerbCompose, VerbComposeCandidate, VerbManifestReads}
|
|
}
|
|
|
|
// Events is every event published on the seat's subject: a new copy each call.
|
|
func Events() []string {
|
|
return []string{EventAsked, EventDone, EventRefused, EventManifestReadsChanged}
|
|
}
|
|
|
|
// Family is where the seat's events are kept: the shared events stream, filtered to the seat's subjects.
|
|
const (
|
|
Family = "node-engine.events"
|
|
FamilyMaxAgeDays = 7
|
|
)
|
|
|
|
// SubjectAsked is where asked is published for one caller.
|
|
func SubjectAsked(caller string) string { return "mesh.seat.node-engine.event.asked." + caller }
|
|
|
|
// SubjectDone is where done is published for one caller.
|
|
func SubjectDone(caller string) string { return "mesh.seat.node-engine.event.done." + caller }
|
|
|
|
// SubjectRefused is where refused is published for one caller.
|
|
func SubjectRefused(caller string) string { return "mesh.seat.node-engine.event.refused." + caller }
|
|
|
|
// SubjectManifestReadsChanged is where manifest-reads-changed is published for one caller.
|
|
func SubjectManifestReadsChanged(caller string) string {
|
|
return "mesh.seat.node-engine.event.manifest-reads-changed." + caller
|
|
}
|
|
|
|
const (
|
|
StateHave = "have"
|
|
StateComposed = "composed"
|
|
StateData = "data"
|
|
StatePackages = "packages"
|
|
StateHealth = "health"
|
|
)
|
|
|
|
// HaveByNodeModuleKey is the key of one value of the state have under the form "<node>.<module>".
|
|
func HaveByNodeModuleKey(node, module string) string { return node + "." + module }
|
|
|
|
// ParseHaveByNodeModuleKey reads the parts of a key of the form "<node>.<module>", in the order of the form; the last result is false for a key of another form.
|
|
func ParseHaveByNodeModuleKey(key string) (string, string, bool) {
|
|
rest := key
|
|
v0, after0, found0 := strings.Cut(rest, ".")
|
|
if !found0 || v0 == "" {
|
|
return "", "", false
|
|
}
|
|
rest = after0
|
|
if rest == "" {
|
|
return "", "", false
|
|
}
|
|
v2 := rest
|
|
rest = ""
|
|
if rest != "" {
|
|
return "", "", false
|
|
}
|
|
return v0, v2, true
|
|
}
|
|
|
|
// DecodeHaveByNodeModuleValue reads one value of the state have under the form "<node>.<module>", refusing a field HaveByNodeModuleValue does not know and any text after the value.
|
|
func DecodeHaveByNodeModuleValue(raw []byte) (HaveByNodeModuleValue, error) {
|
|
var v HaveByNodeModuleValue
|
|
dec := json.NewDecoder(bytes.NewReader(raw))
|
|
dec.DisallowUnknownFields()
|
|
if err := dec.Decode(&v); err != nil {
|
|
return v, err
|
|
}
|
|
if dec.More() {
|
|
return v, errors.New("text after the value")
|
|
}
|
|
return v, nil
|
|
}
|
|
|
|
// HaveByNodeNodeKey is the key of one value of the state have under the form "<node>.node".
|
|
func HaveByNodeNodeKey(node string) string { return node + ".node" }
|
|
|
|
// ParseHaveByNodeNodeKey reads the parts of a key of the form "<node>.node", in the order of the form; the last result is false for a key of another form.
|
|
func ParseHaveByNodeNodeKey(key string) (string, bool) {
|
|
rest := key
|
|
v0, after0, found0 := strings.Cut(rest, ".node")
|
|
if !found0 || v0 == "" {
|
|
return "", false
|
|
}
|
|
rest = after0
|
|
if rest != "" {
|
|
return "", false
|
|
}
|
|
return v0, true
|
|
}
|
|
|
|
// DecodeHaveByNodeNodeValue reads one value of the state have under the form "<node>.node", refusing a field HaveByNodeNodeValue does not know and any text after the value.
|
|
func DecodeHaveByNodeNodeValue(raw []byte) (HaveByNodeNodeValue, error) {
|
|
var v HaveByNodeNodeValue
|
|
dec := json.NewDecoder(bytes.NewReader(raw))
|
|
dec.DisallowUnknownFields()
|
|
if err := dec.Decode(&v); err != nil {
|
|
return v, err
|
|
}
|
|
if dec.More() {
|
|
return v, errors.New("text after the value")
|
|
}
|
|
return v, nil
|
|
}
|
|
|
|
// ComposedByNodeModuleFingerprintKey is the key of one value of the state composed under the form "<node>.<module>.<fingerprint>".
|
|
func ComposedByNodeModuleFingerprintKey(node, module, fingerprint string) string {
|
|
return node + "." + module + "." + fingerprint
|
|
}
|
|
|
|
// ParseComposedByNodeModuleFingerprintKey reads the parts of a key of the form "<node>.<module>.<fingerprint>", in the order of the form; the last result is false for a key of another form.
|
|
func ParseComposedByNodeModuleFingerprintKey(key string) (string, string, string, bool) {
|
|
rest := key
|
|
v0, after0, found0 := strings.Cut(rest, ".")
|
|
if !found0 || v0 == "" {
|
|
return "", "", "", false
|
|
}
|
|
rest = after0
|
|
v2, after2, found2 := strings.Cut(rest, ".")
|
|
if !found2 || v2 == "" {
|
|
return "", "", "", false
|
|
}
|
|
rest = after2
|
|
if rest == "" {
|
|
return "", "", "", false
|
|
}
|
|
v4 := rest
|
|
rest = ""
|
|
if rest != "" {
|
|
return "", "", "", false
|
|
}
|
|
return v0, v2, v4, true
|
|
}
|
|
|
|
// DecodeComposedByNodeModuleFingerprintValue reads one value of the state composed under the form "<node>.<module>.<fingerprint>", refusing a field ComposedByNodeModuleFingerprintValue does not know and any text after the value.
|
|
func DecodeComposedByNodeModuleFingerprintValue(raw []byte) (ComposedByNodeModuleFingerprintValue, error) {
|
|
var v ComposedByNodeModuleFingerprintValue
|
|
dec := json.NewDecoder(bytes.NewReader(raw))
|
|
dec.DisallowUnknownFields()
|
|
if err := dec.Decode(&v); err != nil {
|
|
return v, err
|
|
}
|
|
if dec.More() {
|
|
return v, errors.New("text after the value")
|
|
}
|
|
return v, nil
|
|
}
|
|
|
|
// DataByNodeModuleKey is the key of one value of the state data under the form "<node>.<module>".
|
|
func DataByNodeModuleKey(node, module string) string { return node + "." + module }
|
|
|
|
// ParseDataByNodeModuleKey reads the parts of a key of the form "<node>.<module>", in the order of the form; the last result is false for a key of another form.
|
|
func ParseDataByNodeModuleKey(key string) (string, string, bool) {
|
|
rest := key
|
|
v0, after0, found0 := strings.Cut(rest, ".")
|
|
if !found0 || v0 == "" {
|
|
return "", "", false
|
|
}
|
|
rest = after0
|
|
if rest == "" {
|
|
return "", "", false
|
|
}
|
|
v2 := rest
|
|
rest = ""
|
|
if rest != "" {
|
|
return "", "", false
|
|
}
|
|
return v0, v2, true
|
|
}
|
|
|
|
// DecodeDataByNodeModuleValue reads one value of the state data under the form "<node>.<module>", refusing a field DataByNodeModuleValue does not know and any text after the value.
|
|
func DecodeDataByNodeModuleValue(raw []byte) (DataByNodeModuleValue, error) {
|
|
var v DataByNodeModuleValue
|
|
dec := json.NewDecoder(bytes.NewReader(raw))
|
|
dec.DisallowUnknownFields()
|
|
if err := dec.Decode(&v); err != nil {
|
|
return v, err
|
|
}
|
|
if dec.More() {
|
|
return v, errors.New("text after the value")
|
|
}
|
|
return v, nil
|
|
}
|
|
|
|
// PackagesByNodeKey is the key of one value of the state packages under the form "<node>".
|
|
func PackagesByNodeKey(node string) string { return node }
|
|
|
|
// ParsePackagesByNodeKey reads the parts of a key of the form "<node>", in the order of the form; the last result is false for a key of another form.
|
|
func ParsePackagesByNodeKey(key string) (string, bool) {
|
|
rest := key
|
|
if rest == "" {
|
|
return "", false
|
|
}
|
|
v0 := rest
|
|
rest = ""
|
|
if rest != "" {
|
|
return "", false
|
|
}
|
|
return v0, true
|
|
}
|
|
|
|
// DecodePackagesByNodeValue reads one value of the state packages under the form "<node>", refusing a field PackagesByNodeValue does not know and any text after the value.
|
|
func DecodePackagesByNodeValue(raw []byte) (PackagesByNodeValue, error) {
|
|
var v PackagesByNodeValue
|
|
dec := json.NewDecoder(bytes.NewReader(raw))
|
|
dec.DisallowUnknownFields()
|
|
if err := dec.Decode(&v); err != nil {
|
|
return v, err
|
|
}
|
|
if dec.More() {
|
|
return v, errors.New("text after the value")
|
|
}
|
|
return v, nil
|
|
}
|
|
|
|
// HealthByNodeKey is the key of one value of the state health under the form "<node>".
|
|
func HealthByNodeKey(node string) string { return node }
|
|
|
|
// ParseHealthByNodeKey reads the parts of a key of the form "<node>", in the order of the form; the last result is false for a key of another form.
|
|
func ParseHealthByNodeKey(key string) (string, bool) {
|
|
rest := key
|
|
if rest == "" {
|
|
return "", false
|
|
}
|
|
v0 := rest
|
|
rest = ""
|
|
if rest != "" {
|
|
return "", false
|
|
}
|
|
return v0, true
|
|
}
|
|
|
|
// DecodeHealthByNodeValue reads one value of the state health under the form "<node>", refusing a field HealthByNodeValue does not know and any text after the value.
|
|
func DecodeHealthByNodeValue(raw []byte) (HealthByNodeValue, error) {
|
|
var v HealthByNodeValue
|
|
dec := json.NewDecoder(bytes.NewReader(raw))
|
|
dec.DisallowUnknownFields()
|
|
if err := dec.Decode(&v); err != nil {
|
|
return v, err
|
|
}
|
|
if dec.More() {
|
|
return v, errors.New("text after the value")
|
|
}
|
|
return v, nil
|
|
}
|
|
|
|
// Act is one act asked through the seat, as acts reads it (ADR 0563 §9).
|
|
type Act struct {
|
|
// the act: hand-over, access-act, judge-directories or setuid-search
|
|
Act string `json:"act"`
|
|
// the operator's ask of a hand-over or an access act
|
|
Ask string `json:"ask,omitempty"`
|
|
// when it was asked, RFC 3339
|
|
At string `json:"at"`
|
|
// the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 §4)
|
|
Auto bool `json:"auto,omitempty"`
|
|
// who answered, as the operator's warrant names them
|
|
By string `json:"by,omitempty"`
|
|
// the caller as the runtime proved it
|
|
Caller string `json:"caller"`
|
|
// what the engine read on disk when it judged
|
|
Disk string `json:"disk,omitempty"`
|
|
// when it ended, RFC 3339
|
|
Ended string `json:"ended,omitempty"`
|
|
// when the ask ends unanswered, RFC 3339
|
|
Expires string `json:"expires,omitempty"`
|
|
// the act's id
|
|
ID string `json:"id"`
|
|
// the directory the act changes
|
|
Path string `json:"path,omitempty"`
|
|
// the warrant's proofs
|
|
Proofs []string `json:"proofs,omitempty"`
|
|
// what the engine said of it: its outcome or why it was refused
|
|
Said string `json:"said,omitempty"`
|
|
// the owner, group and mode it sets, in words
|
|
Sets string `json:"sets,omitempty"`
|
|
// where it stands
|
|
State string `json:"state"`
|
|
// the path of a hand-over, or the access of an access act
|
|
Subject string `json:"subject,omitempty"`
|
|
// the channel the warrant came on
|
|
Via string `json:"via,omitempty"`
|
|
// why it was asked, in words
|
|
Why string `json:"why,omitempty"`
|
|
}
|
|
|
|
// The values of Act's state.
|
|
const (
|
|
ActStateAsked = "asked"
|
|
ActStateDone = "done"
|
|
ActStateRefused = "refused"
|
|
ActStateAnswered = "answered"
|
|
)
|
|
|
|
// ActSaid is what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 §1).
|
|
type ActSaid struct {
|
|
// the act
|
|
Act string `json:"act"`
|
|
// the operator's ask
|
|
Ask string `json:"ask,omitempty"`
|
|
// the caller as the runtime proved it
|
|
Caller string `json:"caller"`
|
|
// the node whose engine says it
|
|
Node string `json:"node"`
|
|
// what the engine said of it
|
|
Said string `json:"said,omitempty"`
|
|
// where the act stands
|
|
State string `json:"state"`
|
|
// the path or the access
|
|
Subject string `json:"subject,omitempty"`
|
|
}
|
|
|
|
// The values of ActSaid's state.
|
|
const (
|
|
ActSaidStateAsked = "asked"
|
|
ActSaidStateDone = "done"
|
|
ActSaidStateRefused = "refused"
|
|
)
|
|
|
|
// Acts is the acts kept.
|
|
type Acts struct {
|
|
// the acts, newest first
|
|
Acts []Act `json:"acts"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
}
|
|
|
|
// Asked is the answer of an act the operator is asked.
|
|
type Asked struct {
|
|
// the ask's id: acts shows where it stands
|
|
Asked string `json:"asked"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
// what happens next, in words
|
|
Says string `json:"says"`
|
|
}
|
|
|
|
// ManifestReadsChanged is what a node-engine says when what it reads changed or its node returned (ADR 0618 §4).
|
|
type ManifestReadsChanged struct {
|
|
// when it says it, RFC 3339
|
|
At string `json:"at"`
|
|
// what its engine states it reads now
|
|
ManifestReads []string `json:"manifest-reads,omitempty"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
// the layout's version
|
|
V int64 `json:"v"`
|
|
// started: the engine started or what it states changed; returned: its node returned after being away
|
|
Why string `json:"why"`
|
|
}
|
|
|
|
// The values of ManifestReadsChanged's why.
|
|
const (
|
|
ManifestReadsChangedWhyStarted = "started"
|
|
ManifestReadsChangedWhyReturned = "returned"
|
|
)
|
|
|
|
// Module is one module's composition with the candidate.
|
|
type Module struct {
|
|
// the candidate changes it from the one composed without it
|
|
Changed bool `json:"changed,omitempty"`
|
|
// the composition's digest when composed
|
|
Digest string `json:"digest,omitempty"`
|
|
// the fingerprint it was composed at
|
|
Fp string `json:"fp,omitempty"`
|
|
// the module, node for the node's own composition
|
|
Module string `json:"module"`
|
|
// composed (digest set), refused by the candidate, or held without it too (words set)
|
|
State string `json:"state"`
|
|
// why, for a refused or held one
|
|
Words string `json:"words,omitempty"`
|
|
}
|
|
|
|
// The values of Module's state.
|
|
const (
|
|
ModuleStateComposed = "composed"
|
|
ModuleStateRefused = "refused"
|
|
ModuleStateHeld = "held"
|
|
)
|
|
|
|
// Revision is one revision of a composition key.
|
|
type Revision struct {
|
|
// its digest
|
|
Digest string `json:"digest,omitempty"`
|
|
// the composition's key
|
|
Key string `json:"key"`
|
|
// the latest revision
|
|
Latest bool `json:"latest,omitempty"`
|
|
// why it cannot be read or trusted
|
|
Refused string `json:"refused,omitempty"`
|
|
// how many resources it names
|
|
Resources int64 `json:"resources,omitempty"`
|
|
// its revision
|
|
Revision int64 `json:"revision,omitempty"`
|
|
}
|
|
|
|
// RootVerdict is the engine's root-free verdict (ADR 0563 §6).
|
|
type RootVerdict struct {
|
|
// the machine is root-free
|
|
Free bool `json:"free"`
|
|
// when the engine judged it, RFC 3339
|
|
Judged string `json:"judged"`
|
|
// the machine
|
|
Machine string `json:"machine"`
|
|
// why, in words
|
|
Why string `json:"why"`
|
|
}
|
|
|
|
// Said is the answer of a read-only judgement.
|
|
type Said struct {
|
|
// the node
|
|
Node string `json:"node"`
|
|
// the engine's judgement or search, one line per directory or program
|
|
Said string `json:"said"`
|
|
}
|
|
|
|
// HandOverInput is what hand-over takes.
|
|
type HandOverInput struct {
|
|
// the directory's absolute path, as the engine states it
|
|
Path string `json:"path"`
|
|
// why it is asked, in words the operator reads
|
|
Why string `json:"why,omitempty"`
|
|
}
|
|
|
|
// HandOverAnswer is what hand-over answers.
|
|
type HandOverAnswer = Asked
|
|
|
|
// AccessActInput is what access-act takes.
|
|
type AccessActInput struct {
|
|
// the access, library:<name>
|
|
Access string `json:"access"`
|
|
// the act: take
|
|
Act string `json:"act"`
|
|
// why it is asked, in words the operator reads
|
|
Why string `json:"why,omitempty"`
|
|
}
|
|
|
|
// AccessActAnswer is what access-act answers.
|
|
type AccessActAnswer = Asked
|
|
|
|
// JudgeDirectoriesInput is what judge-directories takes.
|
|
type JudgeDirectoriesInput struct {
|
|
}
|
|
|
|
// JudgeDirectoriesAnswer is what judge-directories answers.
|
|
type JudgeDirectoriesAnswer = Said
|
|
|
|
// SetuidSearchInput is what setuid-search takes.
|
|
type SetuidSearchInput struct {
|
|
// why it is asked, in words
|
|
Why string `json:"why,omitempty"`
|
|
}
|
|
|
|
// SetuidSearchAnswer is what setuid-search answers.
|
|
type SetuidSearchAnswer = Said
|
|
|
|
// RootFreeInput is what root-free takes.
|
|
type RootFreeInput struct {
|
|
}
|
|
|
|
// RootFreeAnswer is what root-free answers.
|
|
type RootFreeAnswer struct {
|
|
// this machine's verdict
|
|
Machines []RootVerdict `json:"machines"`
|
|
}
|
|
|
|
// ActsInput is what acts takes.
|
|
type ActsInput struct {
|
|
// one act, by its id
|
|
ID string `json:"id,omitempty"`
|
|
// at most this many, newest
|
|
Limit string `json:"limit,omitempty"`
|
|
}
|
|
|
|
// ActsAnswer is what acts answers.
|
|
type ActsAnswer = Acts
|
|
|
|
// PackagesInput is what packages takes.
|
|
type PackagesInput struct {
|
|
// "true": write this machine's key again from what the engine composed
|
|
Write string `json:"write,omitempty"`
|
|
}
|
|
|
|
// The values of PackagesInput's write.
|
|
const (
|
|
PackagesInputWriteTrue = "true"
|
|
PackagesInputWriteFalse = "false"
|
|
)
|
|
|
|
// PackagesAnswerKeyPackagesItem is a type of the contract.
|
|
type PackagesAnswerKeyPackagesItem struct {
|
|
// declared absent
|
|
Absent bool `json:"absent"`
|
|
// the modules that declare it
|
|
Modules []string `json:"modules"`
|
|
// the package
|
|
Package string `json:"package"`
|
|
}
|
|
|
|
// PackagesAnswerKey is the node's key as the bus holds it; absent when the engine wrote none.
|
|
type PackagesAnswerKey struct {
|
|
// the node
|
|
Node string `json:"node"`
|
|
// its packages sorted by name, absent after present
|
|
Packages []PackagesAnswerKeyPackagesItem `json:"packages"`
|
|
}
|
|
|
|
// PackagesAnswer is what packages answers.
|
|
type PackagesAnswer struct {
|
|
// the node's key as the bus holds it; absent when the engine wrote none
|
|
Key *PackagesAnswerKey `json:"key,omitempty"`
|
|
// why the key could not be read
|
|
KeyError string `json:"key_error,omitempty"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
// a note, such as that no key is written yet
|
|
Note string `json:"note,omitempty"`
|
|
// where the key is read: the engine's state packages
|
|
Source string `json:"source"`
|
|
// with write: the key was written again (false: it already held what the engine composed)
|
|
Wrote bool `json:"wrote,omitempty"`
|
|
}
|
|
|
|
// CompositionInput is what composition takes.
|
|
type CompositionInput struct {
|
|
// "true": list the resources that differ from what runs
|
|
Diff string `json:"diff,omitempty"`
|
|
// a composition's digest (sha256:…), to read that revision rather than the latest
|
|
Digest string `json:"digest,omitempty"`
|
|
// the module, as placed on this machine; node for the node's own
|
|
Module string `json:"module"`
|
|
}
|
|
|
|
// CompositionAnswerAttempt is the module's last apply that did not end running; absent when none.
|
|
type CompositionAnswerAttempt struct {
|
|
// the want's revision the hold took
|
|
AnsweredRevision int64 `json:"answered_revision,omitempty"`
|
|
// the digest tried
|
|
Composed string `json:"composed,omitempty"`
|
|
// the composition's revision it was tried at
|
|
CompositionRevision int64 `json:"composition_revision"`
|
|
// the fingerprint tried
|
|
Fp string `json:"fp"`
|
|
// held for a failed backup
|
|
Held bool `json:"held,omitempty"`
|
|
// it failed because the bus did not answer for a moment
|
|
Transient bool `json:"transient,omitempty"`
|
|
// the want's revision it was tried at
|
|
WantRevision int64 `json:"want_revision"`
|
|
}
|
|
|
|
// CompositionAnswerHave is what the module's have key says now; absent when it says nothing.
|
|
type CompositionAnswerHave struct {
|
|
// digest
|
|
Composed string `json:"composed,omitempty"`
|
|
// detail
|
|
Detail string `json:"detail,omitempty"`
|
|
// fingerprint
|
|
Fp string `json:"fp,omitempty"`
|
|
// judgement
|
|
Judgement string `json:"judgement,omitempty"`
|
|
// running, failed, held or waiting-yes
|
|
Phase string `json:"phase"`
|
|
// the digest that waits for a yes
|
|
Waits string `json:"waits,omitempty"`
|
|
}
|
|
|
|
// CompositionAnswerJudged is the move from what runs to the composition read.
|
|
type CompositionAnswerJudged struct {
|
|
// the judgement
|
|
Judgement string `json:"judgement"`
|
|
// the agent would wait for a person's yes before applying it
|
|
WaitsForYes bool `json:"waits_for_yes"`
|
|
// its words
|
|
Words string `json:"words"`
|
|
}
|
|
|
|
// CompositionAnswerOwn is of the node's own composition, its own fields beside what runs names.
|
|
type CompositionAnswerOwn struct {
|
|
// the revision's adoption; absent for a converged node
|
|
Adoption map[string]any `json:"adoption,omitempty"`
|
|
// groups
|
|
Groups int64 `json:"groups,omitempty"`
|
|
// each module the node's composer held in its last pass, with why
|
|
Held map[string]string `json:"held,omitempty"`
|
|
// identities the revision names
|
|
Identities int64 `json:"identities,omitempty"`
|
|
// libraries
|
|
Libraries int64 `json:"libraries,omitempty"`
|
|
// the account the provisioner's client runs as, as the revision names it
|
|
ProvisionerAccount string `json:"provisioner_account"`
|
|
// as what runs names it
|
|
RunsProvisionerAccount string `json:"runs_provisioner_account,omitempty"`
|
|
}
|
|
|
|
// CompositionAnswerRuns is what runs of the module; absent when nothing runs.
|
|
type CompositionAnswerRuns struct {
|
|
// digest
|
|
Composed string `json:"composed,omitempty"`
|
|
// fingerprint
|
|
Fp string `json:"fp,omitempty"`
|
|
// applied, have or kept
|
|
From string `json:"from"`
|
|
// phase
|
|
Phase string `json:"phase,omitempty"`
|
|
// how many resources run
|
|
Resources int64 `json:"resources"`
|
|
}
|
|
|
|
// CompositionAnswerWant is the module's want as the agent holds it; absent when it holds none.
|
|
type CompositionAnswerWant struct {
|
|
// the operator's answer to a failed backup, again or skip
|
|
Backup string `json:"backup,omitempty"`
|
|
// the composition's digest it names
|
|
Composed string `json:"composed,omitempty"`
|
|
// its build's fingerprint
|
|
Fp string `json:"fp"`
|
|
// the module is removed
|
|
Removed bool `json:"removed,omitempty"`
|
|
// the revision of the want's key read last
|
|
Revision int64 `json:"revision"`
|
|
// the node composes the module itself (ADR 0547 §2)
|
|
Self bool `json:"self,omitempty"`
|
|
// its words
|
|
Words string `json:"words,omitempty"`
|
|
// the digest a person said yes to
|
|
Yes string `json:"yes,omitempty"`
|
|
}
|
|
|
|
// CompositionAnswer is what composition answers.
|
|
type CompositionAnswer struct {
|
|
// the module's last apply that did not end running; absent when none
|
|
Attempt *CompositionAnswerAttempt `json:"attempt,omitempty"`
|
|
Composition Revision `json:"composition"`
|
|
// every resource that differs from what runs, when asked
|
|
Diff []map[string]any `json:"diff,omitempty"`
|
|
// what the module's have key says now; absent when it says nothing
|
|
Have *CompositionAnswerHave `json:"have,omitempty"`
|
|
// the move from what runs to the composition read
|
|
Judged CompositionAnswerJudged `json:"judged"`
|
|
// the module
|
|
Module string `json:"module"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
// of the node's own composition, its own fields beside what runs names
|
|
Own *CompositionAnswerOwn `json:"own,omitempty"`
|
|
// the revisions of its key the bucket keeps, oldest first
|
|
Revisions []Revision `json:"revisions,omitempty"`
|
|
// what runs of the module; absent when nothing runs
|
|
Runs *CompositionAnswerRuns `json:"runs,omitempty"`
|
|
// the agent has looked at the module once since it started
|
|
Started bool `json:"started"`
|
|
// the module's want as the agent holds it; absent when it holds none
|
|
Want *CompositionAnswerWant `json:"want,omitempty"`
|
|
}
|
|
|
|
// ComposeInput is what compose takes.
|
|
type ComposeInput struct {
|
|
// a module placed on this machine whose apply is also tried again (optional)
|
|
Module string `json:"module,omitempty"`
|
|
}
|
|
|
|
// ComposeAnswerPass is how the pass went.
|
|
type ComposeAnswerPass struct {
|
|
// when the node composes again on its own, RFC 3339
|
|
Again string `json:"again,omitempty"`
|
|
// when the pass ended, RFC 3339
|
|
At string `json:"at"`
|
|
// the answer is the last pass, made moments ago
|
|
Earlier bool `json:"earlier,omitempty"`
|
|
// how many compositions the pass handed the agent that differ from before
|
|
Handed int64 `json:"handed"`
|
|
// each module refused alone, with why
|
|
Held map[string]string `json:"held,omitempty"`
|
|
// why the node composed none of its modules
|
|
Refused string `json:"refused,omitempty"`
|
|
}
|
|
|
|
// ComposeAnswer is what compose answers.
|
|
type ComposeAnswer struct {
|
|
// how the pass went
|
|
Pass ComposeAnswerPass `json:"pass"`
|
|
// the module whose apply was tried again
|
|
Retried string `json:"retried,omitempty"`
|
|
}
|
|
|
|
// ComposeCandidateInput is what compose-candidate takes.
|
|
type ComposeCandidateInput struct {
|
|
// the key of the indexer's candidate, <group>.<heads hash>
|
|
Candidate string `json:"candidate"`
|
|
// also answer the composition input the candidate was composed from, for the sandbox path
|
|
Input bool `json:"input,omitempty"`
|
|
}
|
|
|
|
// ComposeCandidateAnswer is what compose-candidate answers.
|
|
type ComposeCandidateAnswer struct {
|
|
// the candidate's key
|
|
Candidate string `json:"candidate"`
|
|
// when asked: the composition input it composed from
|
|
Input map[string]any `json:"input,omitempty"`
|
|
// every module placed on the node, sorted by name
|
|
Modules []Module `json:"modules"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
Own Module `json:"own"`
|
|
// why the node could not compose with the candidate at all
|
|
Refused string `json:"refused,omitempty"`
|
|
// how long the engine took, in milliseconds
|
|
Took int64 `json:"took"`
|
|
// the layout's version
|
|
V int64 `json:"v"`
|
|
// the node's verdict (ADR 0593 §7, §9)
|
|
Verdict string `json:"verdict"`
|
|
}
|
|
|
|
// The values of ComposeCandidateAnswer's verdict.
|
|
const (
|
|
ComposeCandidateAnswerVerdictComposed = "composed"
|
|
ComposeCandidateAnswerVerdictRefused = "refused"
|
|
ComposeCandidateAnswerVerdictUnready = "unready"
|
|
ComposeCandidateAnswerVerdictNotJudged = "not-judged"
|
|
)
|
|
|
|
// ManifestReadsInput is what manifest-reads takes.
|
|
type ManifestReadsInput struct {
|
|
}
|
|
|
|
// ManifestReadsAnswer is what manifest-reads answers.
|
|
type ManifestReadsAnswer struct {
|
|
// the reader capabilities its engine states: the manifest words, forms and seat names it reads; empty for an engine built before it said them, read as the baseline
|
|
ManifestReads []string `json:"manifest-reads,omitempty"`
|
|
// the node
|
|
Node string `json:"node"`
|
|
// when the engine last stated them, RFC 3339
|
|
StatedAt string `json:"stated-at"`
|
|
// the layout's version
|
|
V int64 `json:"v"`
|
|
}
|
|
|
|
// AskedEvent is the body of the event asked.
|
|
type AskedEvent = ActSaid
|
|
|
|
// DoneEvent is the body of the event done.
|
|
type DoneEvent = ActSaid
|
|
|
|
// RefusedEvent is the body of the event refused.
|
|
type RefusedEvent = ActSaid
|
|
|
|
// ManifestReadsChangedEvent is the body of the event manifest-reads-changed.
|
|
type ManifestReadsChangedEvent = ManifestReadsChanged
|
|
|
|
// HaveByNodeModuleValue is one value of the state have under the key <node>.<module>.
|
|
type HaveByNodeModuleValue struct {
|
|
Build string `json:"build,omitempty"`
|
|
BuildAlone bool `json:"build-alone,omitempty"`
|
|
// the composition's digest
|
|
Composed string `json:"composed,omitempty"`
|
|
Detail string `json:"detail,omitempty"`
|
|
// the fingerprint held
|
|
Fp string `json:"fp,omitempty"`
|
|
// the accounts handed
|
|
Handed map[string]any `json:"handed,omitempty"`
|
|
// how it is
|
|
Health string `json:"health"`
|
|
Judgement string `json:"judgement,omitempty"`
|
|
Kept []string `json:"kept,omitempty"`
|
|
// how far it has come
|
|
Phase string `json:"phase"`
|
|
// a pull the engine waits for
|
|
PullWait map[string]any `json:"pull-wait,omitempty"`
|
|
Sealed []string `json:"sealed,omitempty"`
|
|
SealedAt map[string]any `json:"sealed-at,omitempty"`
|
|
// the user list written
|
|
UserList map[string]any `json:"user-list,omitempty"`
|
|
V int64 `json:"v"`
|
|
// what it waits for
|
|
Waits string `json:"waits,omitempty"`
|
|
}
|
|
|
|
// HaveByNodeNodeValue is one value of the state have under the key <node>.node.
|
|
type HaveByNodeNodeValue struct {
|
|
Busy map[string]any `json:"busy,omitempty"`
|
|
Candidates map[string]map[string]any `json:"candidates,omitempty"`
|
|
Composed string `json:"composed,omitempty"`
|
|
// own, or the controller's
|
|
Composes string `json:"composes,omitempty"`
|
|
ComposesWhy string `json:"composes-why,omitempty"`
|
|
Filters map[string]any `json:"filters,omitempty"`
|
|
Profile map[string]any `json:"profile,omitempty"`
|
|
// the node's record: its tunnel and certificate
|
|
Record map[string]any `json:"record,omitempty"`
|
|
Sealed []string `json:"sealed,omitempty"`
|
|
SealedAt map[string]any `json:"sealed-at,omitempty"`
|
|
Strays map[string]any `json:"strays,omitempty"`
|
|
V int64 `json:"v"`
|
|
Windows map[string]any `json:"windows,omitempty"`
|
|
}
|
|
|
|
// ComposedByNodeModuleFingerprintValue is one value of the state composed under the key <node>.<module>.<fingerprint>.
|
|
type ComposedByNodeModuleFingerprintValue struct {
|
|
Data bool `json:"Data,omitempty"`
|
|
FP string `json:"FP"`
|
|
Filled []string `json:"Filled,omitempty"`
|
|
Module string `json:"Module"`
|
|
Node string `json:"Node"`
|
|
// the node's own adoption, identities, groups, libraries and provisioner account
|
|
Own map[string]any `json:"Own,omitempty"`
|
|
// the module's plan
|
|
Plan map[string]any `json:"Plan,omitempty"`
|
|
// why the composition was refused
|
|
Refused string `json:"Refused,omitempty"`
|
|
Resources []map[string]any `json:"Resources,omitempty"`
|
|
V int64 `json:"V,omitempty"`
|
|
}
|
|
|
|
// DataByNodeModuleValue is one value of the state data under the key <node>.<module>.
|
|
type DataByNodeModuleValue struct {
|
|
Digest string `json:"digest"`
|
|
Items []map[string]any `json:"items"`
|
|
Module string `json:"module"`
|
|
Node string `json:"node"`
|
|
V int64 `json:"v,omitempty"`
|
|
}
|
|
|
|
// PackagesByNodeValuePackagesItem is a type of the contract.
|
|
type PackagesByNodeValuePackagesItem struct {
|
|
Absent bool `json:"absent,omitempty"`
|
|
Modules []string `json:"modules,omitempty"`
|
|
Package string `json:"package,omitempty"`
|
|
}
|
|
|
|
// PackagesByNodeValue is one value of the state packages under the key <node>.
|
|
type PackagesByNodeValue struct {
|
|
Node string `json:"node"`
|
|
Packages []PackagesByNodeValuePackagesItem `json:"packages"`
|
|
}
|
|
|
|
// HealthByNodeValue is one value of the state health under the key <node>.
|
|
type HealthByNodeValue struct {
|
|
At string `json:"at"`
|
|
Contract int64 `json:"contract,omitempty"`
|
|
Fallback map[string]any `json:"fallback,omitempty"`
|
|
Found []map[string]any `json:"found,omitempty"`
|
|
Network map[string]any `json:"network,omitempty"`
|
|
Node string `json:"node"`
|
|
Peers []map[string]any `json:"peers,omitempty"`
|
|
Relogin []map[string]any `json:"relogin,omitempty"`
|
|
Root []map[string]any `json:"root,omitempty"`
|
|
Units map[string]any `json:"units,omitempty"`
|
|
V int64 `json:"v"`
|
|
}
|