deploy

Documentation

Index

• Variables
• func BuildResourceMap(ctx context.Context, dependencies []*resources.ResourceDependency) (map[string]RawJSONObject, error)
• func ComputeIngress(rootenv cfg.Context, planner runtime.Planner, stack *schema.Stack, ...) compute.Computable[*ComputeIngressResult]
• func ComputeStackAndImages(ctx context.Context, env cfg.Context, planner runtime.Planner, ...) (*planning.Stack, []compute.Computable[ResolvedServerImages], error)
• func MakeBuildPlan(ctx context.Context, rc runtime.Planner, server planning.Server, focused bool, ...) (build.Plan, error)
• func MaybeRenderBlock(env cfg.Context, cluster runtime.ClusterNamespace, render bool) execution.WaitHandler
• func PlanIngressDeployment(rc runtime.Planner, c compute.Computable[*ComputeIngressResult]) compute.Computable[*runtime.DeploymentPlan]
• func PlanResourceProviderInvocation(ctx context.Context, modules pkggraph.Modules, planner runtime.Planner, ...) ([]*schema.SerializedInvocation, error)
• func PrepareDeployServers(ctx context.Context, env cfg.Context, modules pkggraph.Modules, ...) (compute.Computable[*Plan], error)
• func PrepareDeployStack(ctx context.Context, env cfg.Context, modules pkggraph.Modules, ...) (compute.Computable[*Plan], error)
• func RegisterDeployOps()
• func Serialize(ws *schema.Workspace, env *schema.Environment, stack *schema.Stack, ...) *schema.DeployPlan
• func TestStackToRuntimeConfig(stack *planning.Stack, sutServers []string) (*runtime.RuntimeConfig, error)
• type ComputeIngressResult
• type InvokeResourceProvider
• type Plan
• type PreparedDeployable
  • func (pd PreparedDeployable) PackageRef() *schema.PackageRef
  • func (pd PreparedDeployable) SealedContext() pkggraph.SealedContext
• type RawJSONObject
• type ResolvedBinary
• type ResolvedServerImages
• type ResourceMap
• type SecretRequest
• type SecretSource
• type SecretsContext

Variables

var (
	AlsoDeployIngress        = true
	PushPrebuiltsToRegistry  = true
	MirrorPrebuiltToRegistry = false
)

var GarbageCollectProviders = true

var RunCodegen = true

Functions

func BuildResourceMap

func BuildResourceMap(ctx context.Context, dependencies []*resources.ResourceDependency) (map[string]RawJSONObject, error)

func ComputeIngress

func ComputeIngress(rootenv cfg.Context, planner runtime.Planner, stack *schema.Stack, plans compute.Computable[[]*schema.IngressFragment], allocate bool) compute.Computable[*ComputeIngressResult]

func ComputeStackAndImages

func ComputeStackAndImages(ctx context.Context, env cfg.Context, planner runtime.Planner, servers planning.Servers) (*planning.Stack, []compute.Computable[ResolvedServerImages], error)

func MakeBuildPlan

func MakeBuildPlan(ctx context.Context, rc runtime.Planner, server planning.Server, focused bool, spec build.Spec) (build.Plan, error)

func MaybeRenderBlock

func MaybeRenderBlock(env cfg.Context, cluster runtime.ClusterNamespace, render bool) execution.WaitHandler

func PlanIngressDeployment

func PlanIngressDeployment(rc runtime.Planner, c compute.Computable[*ComputeIngressResult]) compute.Computable[*runtime.DeploymentPlan]

func PlanResourceProviderInvocation

func PlanResourceProviderInvocation(ctx context.Context, modules pkggraph.Modules, planner runtime.Planner, invoke *InvokeResourceProvider) ([]*schema.SerializedInvocation, error)

func PrepareDeployServers

func PrepareDeployServers(ctx context.Context, env cfg.Context, modules pkggraph.Modules, planner runtime.Planner, focus ...planning.Server) (compute.Computable[*Plan], error)

func PrepareDeployStack

func PrepareDeployStack(ctx context.Context, env cfg.Context, modules pkggraph.Modules, planner runtime.Planner, registry registry.Manager, stack *planning.Stack, prepared ...compute.Computable[PreparedDeployable]) (compute.Computable[*Plan], error)

func RegisterDeployOps

func RegisterDeployOps()

func Serialize

func Serialize(ws *schema.Workspace, env *schema.Environment, stack *schema.Stack, computed *Plan, focus schema.PackageList) *schema.DeployPlan

func TestStackToRuntimeConfig

func TestStackToRuntimeConfig(stack *planning.Stack, sutServers []string) (*runtime.RuntimeConfig, error)

Types

type ComputeIngressResult

type ComputeIngressResult struct {
	Fragments []*schema.IngressFragment
	// contains filtered or unexported fields
}

type InvokeResourceProvider

type InvokeResourceProvider struct {
	ResourceInstanceId   string
	SerializedIntentJson []byte
	BinaryRef            *schema.PackageRef
	BinaryImageId        oci.ImageID
	BinaryConfig         *schema.BinaryConfig
	ResourceClass        *schema.ResourceClass
	ResourceProvider     *schema.ResourceProvider
	InstanceTypeSource   *protos2.FileDescriptorSetAndDeps
	ResourceDependencies []*resources.ResourceDependency
	SecretResources      []runtime.SecretResourceDependency
}

type Plan

type Plan struct {
	Deployer           *execution.Plan
	ComputedStack      *planning.Stack
	IngressFragments   []*schema.IngressFragment
	Computed           *schema.ComputedConfigurations
	Hints              []string // Optional messages to pass to the user.
	NamespaceReference string
}

type PreparedDeployable

type PreparedDeployable struct {
	Ref       *schema.PackageRef
	Template  runtime.DeployableSpec
	SealedCtx pkggraph.SealedContext
	Resources []pkggraph.ResourceInstance
}

func (PreparedDeployable) PackageRef

func (pd PreparedDeployable) PackageRef() *schema.PackageRef

func (PreparedDeployable) SealedContext

func (pd PreparedDeployable) SealedContext() pkggraph.SealedContext

type RawJSONObject

type RawJSONObject map[string]any

type ResolvedBinary

type ResolvedBinary struct {
	PackageRef   *schema.PackageRef
	Binary       oci.ImageID
	BinaryConfig *schema.BinaryConfig
}

type ResolvedServerImages

type ResolvedServerImages struct {
	PackageRef     *schema.PackageRef
	Binary         oci.ImageID
	BinaryImage    compute.Computable[oci.ResolvableImage]
	PrebuiltBinary bool
	Config         *oci.ImageID
	Sidecars       []ResolvedBinary
}

type ResourceMap

type ResourceMap map[string]ownedResourceInstances // The key is a canonical PackageRef.

type SecretRequest

type SecretRequest struct {
	SecretsContext SecretsContext
	Server         struct {
		PackageName schema.PackageName
		ModuleName  string
		RelPath     string // Relative path within the module.
	}
	SecretRef *schema.PackageRef
}

type SecretSource

type SecretSource interface {
	Load(context.Context, SecretRequest) (*schema.FileContents, error)
	MissingError(refs []*schema.PackageRef, specs []*schema.SecretSpec, servers []schema.PackageName) error
}

type SecretsContext

type SecretsContext struct {
	WorkspaceModuleName string
	Environment         *schema.Environment
}