demos

type Demo interface {
	// Name is the demo's registry name, e.g. "demo-counter".
	Name() string
	// Description is the one-line summary shown in help.
	Description() string
	// Flags registers demo-specific flags, if any.
	Flags(fs *pflag.FlagSet)
	// Deploy installs the demo.
	Deploy(ctx context.Context, e *steps.Env) error
	// Delete removes the demo. It must succeed on a cluster where the demo was
	// never installed, because DeleteAll runs every demo's Delete.
	Delete(ctx context.Context, e *steps.Env) error
}

type Simple struct {
	// DemoName is the registry name, e.g. "demo-counter". It cannot be called
	// Name: that is the accessor the Demo interface requires.
	DemoName string
	// Short is the one-line summary, in cobra's sense of the word.
	Short string

	// Template is the *.yaml.tmpl path, relative to the repository root.
	Template string

	// Deployments are the Deployments to wait for at deploy time, in order.
	// The WorkerPool controller names each Deployment after its WorkerPool.
	Deployments []steps.TemplateRef

	// ActorTemplates are the demo's ActorTemplates. Their actors are removed
	// before the manifests at delete time.
	ActorTemplates []steps.TemplateRef
}

type Substrate struct {
	// DemoName is the registry name, e.g. "demo-parking".
	DemoName string
	// Short is the one-line summary, in cobra's sense of the word.
	Short string

	// WorkerPoolManifest is the *.yaml.tmpl holding the namespace and
	// WorkerPool, relative to the repository root.
	WorkerPoolManifest string

	// Deployments are the pool Deployments to wait for at deploy time, in
	// order. The WorkerPool controller names each Deployment after its
	// WorkerPool.
	Deployments []steps.TemplateRef

	// Templates are the demo's ActorTemplates, created in order.
	Templates []SubstrateTemplate

	// RenderValues optionally supplies extra placeholder values at deploy
	// time, for demos whose manifests need more than ${BUCKET_NAME} (e.g. a
	// freshly built image digest). Delete renders only the pool manifest, so
	// deploy-only values may live solely here.
	RenderValues func(ctx context.Context, e *steps.Env) (map[string]string, error)
}

type SubstrateTemplate struct {
	// Manifest is the protojson *.yaml.tmpl path, relative to the repository
	// root.
	Manifest string
	// Ref is the template's (atespace, name) identity.
	Ref resources.ActorTemplateRef
}