installer

type Container struct {
	LookupEnv func(key string) (string, bool)
	// FS is the container's filesystem, rooted at "/".
	FS fs.FS
}

type InstallOptions struct {
	Events progress.Sink
}

type Installation struct {
	Stack    string
	Bundle   string
	Version  string
	Revision string
}

type NewOrchestratorFunc func(ctx context.Context) (Orchestrator, error)

type Operation struct {
	Installation string
	Revision     string
	Action       string
	Bundle       cnab.ExtendedBundle

	// Parameters holds every parameter that applies to the action, typed by
	// its definition: the value the runtime delivered, else the default.
	Parameters map[string]any

	// Credentials holds every credential the runtime delivered for the action.
	Credentials map[string]string

	// Relocation maps the bundle's image references to where the images are
	// on the target. It is empty when the images were not relocated.
	Relocation relocation.ImageRelocationMap
	// contains filtered or unexported fields
}

type Options struct {
	Orchestrator string
	Timeout      time.Duration
	Purge        bool
	// VolumeTypes are what the target makes the volumes of each type of.
	VolumeTypes map[string]target.VolumeType
	// RegistryAuth holds the credentials the images are pulled with.
	RegistryAuth RegistryAuth
}

type Orchestrator interface {
	// Name is the value of the nemo-orchestrator parameter that selects it.
	Name() string

	// Validate reports what it can't honour in the project, without touching the target.
	Validate(project *Project) error

	// Install brings the installation to the project: it creates what is
	// missing, updates what changed, removes what the project no longer
	// declares, and waits until everything converged. It is also the upgrade.
	Install(ctx context.Context, project *Project, opts InstallOptions) error

	// Uninstall removes everything the installation created.
	Uninstall(ctx context.Context, project *Project, opts UninstallOptions) error

	// Close releases the connection to the target.
	Close() error
}

type Orchestrators map[string]NewOrchestratorFunc

type Problem struct {
	Path    string `json:"path"`
	Message string `json:"message"`
}

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

type Project struct {
	Installation Installation

	// Compose is the compose project, named after the stack. Its configs and
	// secrets hold their content: an orchestrator never reads a file or a
	// variable of the installer to get it.
	Compose *types.Project

	// Levels holds the services in the order of their depends_on: each level
	// only depends on the levels before it.
	Levels [][]string

	// Labels go on every object of the installation.
	Labels map[string]string

	// Provisions holds, by volume name, the directory to create before the
	// volume, as its target's volume type says.
	Provisions map[string]target.VolumeProvision

	// InvocationImage is the installer's own image, which provisions the
	// volumes' directories.
	InvocationImage string

	// RegistryAuth holds the credentials the images are pulled with.
	RegistryAuth RegistryAuth
}

type RegistryAuth map[string]registry.AuthConfig

type UninstallOptions struct {
	Events progress.Sink
	// RemoveVolumes also removes the volumes, and the data they hold.
	RemoveVolumes bool
}

type VolumeClaim struct {
	Type    string   `json:"type"`
	Options []string `json:"options,omitempty"`
}