runtime

Documentation

Index

• Constants
• func GetDependencyDefinition(c *portercontext.Context, alias string) ([]byte, error)
• func GetDependencyDefinitionPath(alias string) string
• type ActionInput
  • func (a *ActionInput) MarshalYAML() (interface{}, error)
• type PorterRuntime
  • func NewPorterRuntime(runtimeCfg RuntimeConfig, mixins pkgmgmt.PackageManager) *PorterRuntime
  • func (r *PorterRuntime) Execute(ctx context.Context, rm *RuntimeManifest) error
  • func (r *PorterRuntime) NewRuntimeManifest(action string, m *manifest.Manifest) *RuntimeManifest
• type RuntimeConfig
  • func NewConfig() RuntimeConfig
  • func NewConfigFor(config *config.Config) RuntimeConfig
  • func (c RuntimeConfig) ConfigureLogging(ctx context.Context) (context.Context, error)
• type RuntimeManifest
  • func NewRuntimeManifest(cfg RuntimeConfig, action string, manifest *manifest.Manifest) *RuntimeManifest
  • func (m *RuntimeManifest) ApplyStepOutputs(assignments map[string]string) error
  • func (m *RuntimeManifest) Finalize(ctx context.Context) error
  • func (m *RuntimeManifest) GetInstallationName() string
  • func (m *RuntimeManifest) GetInstallationNamespace() string
  • func (m *RuntimeManifest) GetOutputs() map[string]string
  • func (m *RuntimeManifest) GetSensitiveValues() []string
  • func (m *RuntimeManifest) GetSteps() manifest.Steps
  • func (m *RuntimeManifest) Initialize(ctx context.Context) error
  • func (m *RuntimeManifest) ReadDependencyOutputValue(ref manifest.DependencyOutputReference) (string, error)
  • func (m *RuntimeManifest) ResolveImages(bun cnab.ExtendedBundle, reloMap relocation.ImageRelocationMap) error
  • func (m *RuntimeManifest) ResolveInvocationImage(bun cnab.ExtendedBundle, reloMap relocation.ImageRelocationMap) error
  • func (m *RuntimeManifest) ResolveStep(ctx context.Context, stepIndex int, step *manifest.Step) error
  • func (m *RuntimeManifest) Validate() error
• type StepOutput
• type TestPorterRuntime
  • func NewTestPorterRuntime(t *testing.T) *TestPorterRuntime
• type TestRuntimeConfig
  • func NewTestRuntimeConfig(t *testing.T) TestRuntimeConfig

Constants

const (
	BundleDependenciesDir = "/cnab/app/dependencies"
)

Functions

func GetDependencyDefinition

func GetDependencyDefinition(c *portercontext.Context, alias string) ([]byte, error)

func GetDependencyDefinitionPath

func GetDependencyDefinitionPath(alias string) string

Types

type ActionInput

type ActionInput struct {
	Steps []*manifest.Step `yaml:"steps"`
	// contains filtered or unexported fields
}

func (*ActionInput) MarshalYAML

func (a *ActionInput) MarshalYAML() (interface{}, error)

MarshalYAML marshals the step nested under the action install:

• helm3: ...

Solution from https://stackoverflow.com/a/42547226

type PorterRuntime

type PorterRuntime struct {
	RuntimeManifest *RuntimeManifest
	// contains filtered or unexported fields
}

PorterRuntime orchestrates executing a bundle and managing state.

func NewPorterRuntime

func NewPorterRuntime(runtimeCfg RuntimeConfig, mixins pkgmgmt.PackageManager) *PorterRuntime

func (*PorterRuntime) Execute

func (r *PorterRuntime) Execute(ctx context.Context, rm *RuntimeManifest) error

func (*PorterRuntime) NewRuntimeManifest

func (r *PorterRuntime) NewRuntimeManifest(action string, m *manifest.Manifest) *RuntimeManifest

type RuntimeConfig

type RuntimeConfig struct {
	*config.Config

	// DebugMode indicates if the bundle is running in debug mode.
	DebugMode bool
}

RuntimeConfig is a specialized config.Config with additional runtime-specific settings.

func NewConfig

func NewConfig() RuntimeConfig

NewConfig returns an initialized RuntimeConfig

func NewConfigFor

func NewConfigFor(config *config.Config) RuntimeConfig

NewConfigFor returns an initialized RuntimeConfig using the specified context.

func (RuntimeConfig) ConfigureLogging

func (c RuntimeConfig) ConfigureLogging(ctx context.Context) (context.Context, error)

type RuntimeManifest

type RuntimeManifest struct {
	*manifest.Manifest

	Action string
	// contains filtered or unexported fields
}

func NewRuntimeManifest

func NewRuntimeManifest(cfg RuntimeConfig, action string, manifest *manifest.Manifest) *RuntimeManifest

func (*RuntimeManifest) ApplyStepOutputs

func (m *RuntimeManifest) ApplyStepOutputs(assignments map[string]string) error

func (*RuntimeManifest) Finalize

func (m *RuntimeManifest) Finalize(ctx context.Context) error

Finalize cleans up the bundle before its completion.

func (*RuntimeManifest) GetInstallationName

func (m *RuntimeManifest) GetInstallationName() string

func (*RuntimeManifest) GetInstallationNamespace

func (m *RuntimeManifest) GetInstallationNamespace() string

func (*RuntimeManifest) GetOutputs

func (m *RuntimeManifest) GetOutputs() map[string]string

func (*RuntimeManifest) GetSensitiveValues

func (m *RuntimeManifest) GetSensitiveValues() []string

func (*RuntimeManifest) GetSteps

func (m *RuntimeManifest) GetSteps() manifest.Steps

func (*RuntimeManifest) Initialize

func (m *RuntimeManifest) Initialize(ctx context.Context) error

Initialize prepares the runtime environment prior to step execution

func (*RuntimeManifest) ReadDependencyOutputValue

func (m *RuntimeManifest) ReadDependencyOutputValue(ref manifest.DependencyOutputReference) (string, error)

ReadDependencyOutputValue reads the dependency's output using the alias for the dependency from the specified output parameter source (name).

func (*RuntimeManifest) ResolveImages

func (m *RuntimeManifest) ResolveImages(bun cnab.ExtendedBundle, reloMap relocation.ImageRelocationMap) error

ResolveImages updates the RuntimeManifest to properly reflect the image map passed to the bundle via the mounted bundle.json and relocation mapping

func (*RuntimeManifest) ResolveInvocationImage

func (m *RuntimeManifest) ResolveInvocationImage(bun cnab.ExtendedBundle, reloMap relocation.ImageRelocationMap) error

ResolveInvocationImage updates the RuntimeManifest to properly reflect the invocation image passed to the bundle via the mounted bundle.json and relocation mapping

func (*RuntimeManifest) ResolveStep

func (m *RuntimeManifest) ResolveStep(ctx context.Context, stepIndex int, step *manifest.Step) error

ResolveStep will walk through the Step's data and resolve any placeholder data using the definitions in the manifest, like parameters or credentials.

func (*RuntimeManifest) Validate

func (m *RuntimeManifest) Validate() error

type StepOutput

type StepOutput struct {
	Name string                 `yaml:"name"`
	Data map[string]interface{} `yaml:",inline"`
	// contains filtered or unexported fields
}

type TestPorterRuntime

type TestPorterRuntime struct {
	*PorterRuntime
	TestContext *portercontext.TestContext
}

func NewTestPorterRuntime

func NewTestPorterRuntime(t *testing.T) *TestPorterRuntime

type TestRuntimeConfig

type TestRuntimeConfig struct {
	RuntimeConfig
	TestContext *portercontext.TestContext
}

func NewTestRuntimeConfig

func NewTestRuntimeConfig(t *testing.T) TestRuntimeConfig