porter

package
v1.0.0-alpha.16 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 30, 2022 License: Apache-2.0 Imports: 79 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	// DockerDriver is the name of the Docker driver.
	DockerDriver = cnabprovider.DriverNameDocker

	// DebugDriver is the name of the Debug driver.
	DebugDriver = cnabprovider.DriverNameDebug

	// DefaultDriver is the name of the default driver (Docker).
	DefaultDriver = DockerDriver
)
View Source 
const ApplyDefaultFormat = printer.FormatPlaintext
View Source 
const BuildDriverDefault = config.BuildDriverDocker
View Source 
const (
	SkeletorRepo = "https://github.com/getporter/skeletor"
)

Variables

View Source 
var (
	// ErrUnsafeInstallationDelete warns the user that deletion of an unsuccessfully uninstalled installation is unsafe
	ErrUnsafeInstallationDelete = errors.New("it is unsafe to delete an installation when the last action wasn't a successful uninstall")

	// ErrUnsafeInstallationDeleteRetryForce presents the ErrUnsafeInstallationDelete error and provides a retry option of --force
	ErrUnsafeInstallationDeleteRetryForce = fmt.Errorf("%s; if you are sure it should be deleted, retry the last command with the --force flag", ErrUnsafeInstallationDelete)
)
View Source 
var (
	LintAllowFormats   = printer.Formats{printer.FormatPlaintext, printer.FormatJson}
	LintDefaultFormats = printer.FormatPlaintext
)
View Source 
var (
	ShowAllowedFormats = []printer.Format{printer.FormatPlaintext, printer.FormatYaml, printer.FormatJson}
	ShowDefaultFormat  = printer.FormatPlaintext
)
View Source 
var ApplyAllowedFormats = printer.Formats{printer.FormatPlaintext, printer.FormatYaml, printer.FormatJson}
View Source 
var BuildDriverAllowedValues = []string{config.BuildDriverDocker, config.BuildDriverBuildkit}
View Source 
var ErrUnsafeInstallationDeleteRetryForceDelete = fmt.Errorf("%s; if you are sure it should be deleted, retry the last command with the --force-delete flag", ErrUnsafeInstallationDelete)

ErrUnsafeInstallationDeleteRetryForceDelete presents the ErrUnsafeInstallationDelete error and provides a retry option of --force-delete

Functions

func NewContextOptions 

func NewContextOptions(cxt *portercontext.Context) contextOptions

Types

type ApplyOptions added in v1.0.1 

type ApplyOptions struct {
	Namespace string
	File      string

	// Force the installation to be re-applied regardless of anything being changed or not
	Force bool

	// DryRun only checks if the changes would trigger a bundle run
	DryRun bool
}

func (*ApplyOptions) Validate added in v1.0.1 

func (o *ApplyOptions) Validate(cxt *portercontext.Context, args []string) error

type ArchiveOptions 

type ArchiveOptions struct {
	BundleActionOptions
	ArchiveFile string
}

ArchiveOptions defines the valid options for performing an archive operation

func (*ArchiveOptions) LoadParameters added in v0.30.0 

func (o *ArchiveOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*ArchiveOptions) Validate 

func (o *ArchiveOptions) Validate(args []string, p *Porter) error

Validate performs validation on the publish options

type BuildOptions 

type BuildOptions struct {

	// NoLint indicates if lint should be run before build.
	NoLint bool

	// Driver to use when building the invocation image.
	Driver string
	// contains filtered or unexported fields
}

func (BuildOptions) Apply 

func (o BuildOptions) Apply(cxt *portercontext.Context)

func (*BuildOptions) Validate added in v0.31.0 

func (o *BuildOptions) Validate(p *Porter) error

type BundleAction added in v0.28.0 

type BundleAction interface {
	// GetAction returns the type of action: install, upgrade, invoke, uninstall
	GetAction() string

	// GetActionVerb returns the appropriate verb (present participle, e.g. -ing)
	// for the action.
	GetActionVerb() string

	// GetOptions returns the common bundle action options used to execute the bundle.
	GetOptions() *BundleActionOptions

	// Validate the action before it is executed.
	Validate(args []string, p *Porter) error
}

BundleAction is an interface that defines a method for supplying BundleLifecycleOptions. This is useful when implementations contain action-specific options beyond the stock BundleLifecycleOptions.

type BundleActionOptions added in v0.30.0 

type BundleActionOptions struct {
	BundlePullOptions
	AllowDockerHostAccess bool
	NoLogs                bool
	// contains filtered or unexported fields
}

func (*BundleActionOptions) GetOptions added in v0.30.0 

func (o *BundleActionOptions) GetOptions() *BundleActionOptions

func (*BundleActionOptions) LoadParameters added in v0.30.0 

func (o *BundleActionOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*BundleActionOptions) Validate added in v0.30.0 

func (o *BundleActionOptions) Validate(args []string, porter *Porter) error

type BundlePullOptions 

type BundlePullOptions struct {
	Reference string

	InsecureRegistry bool
	Force            bool
	// contains filtered or unexported fields
}

func (*BundlePullOptions) GetReference added in v1.0.1 

func (b *BundlePullOptions) GetReference() cnab.OCIReference

func (*BundlePullOptions) Validate added in v1.0.1 

func (b *BundlePullOptions) Validate() error

type BundleResolver 

type BundleResolver struct {
	Cache    cache.BundleCache
	Registry cnabtooci.RegistryProvider
}

func (*BundleResolver) Resolve 

func (r *BundleResolver) Resolve(opts BundlePullOptions) (cache.CachedBundle, error)

Resolves a bundle from the cache, or pulls it and caches it Returns the location of the bundle or an error

type CopyOpts 

type CopyOpts struct {
	Source string

	Destination      string
	InsecureRegistry bool
	// contains filtered or unexported fields
}

func (*CopyOpts) Validate 

func (c *CopyOpts) Validate() error

Validate performs validation logic on the options specified for a bundle copy

type CredentialCreateOptions added in v1.0.1 

type CredentialCreateOptions struct {
	FileName   string
	OutputType string
}

CredentialCreateOptions represent options for Porter's credential create command

func (*CredentialCreateOptions) Validate added in v1.0.1 

func (o *CredentialCreateOptions) Validate(args []string) error

type CredentialDeleteOptions 

type CredentialDeleteOptions struct {
	Name      string
	Namespace string
}

CredentialDeleteOptions represent options for Porter's credential delete command

func (*CredentialDeleteOptions) Validate 

func (o *CredentialDeleteOptions) Validate(args []string) error

Validate validates the args provided Porter's credential delete command

type CredentialEditOptions 

type CredentialEditOptions struct {
	Name      string
	Namespace string
}

func (*CredentialEditOptions) Validate 

func (o *CredentialEditOptions) Validate(args []string) error

Validate validates the args provided to Porter's credential edit command

type CredentialOptions 

type CredentialOptions struct {
	BundleActionOptions
	Silent bool
	Labels []string
}

CredentialsOptions are the set of options available to Porter.GenerateCredentials

func (*CredentialOptions) LoadParameters added in v0.30.0 

func (o *CredentialOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (CredentialOptions) ParseLabels added in v1.0.1 

func (o CredentialOptions) ParseLabels() map[string]string

func (*CredentialOptions) Validate 

func (o *CredentialOptions) Validate(args []string, p *Porter) error

Validate prepares for an action and validates the options. For example, relative paths are converted to full paths and then checked that they exist and are accessible.

type CredentialShowOptions 

type CredentialShowOptions struct {
	printer.PrintOptions
	Name      string
	Namespace string
}

CredentialShowOptions represent options for Porter's credential show command

func (*CredentialShowOptions) Validate 

func (o *CredentialShowOptions) Validate(args []string) error

Validate validates the args provided to Porter's credential show command

type DeleteOptions added in v0.28.0 

type DeleteOptions struct {
	Force bool
	// contains filtered or unexported fields
}

DeleteOptions represent options for Porter's installation delete command

func (*DeleteOptions) LoadParameters added in v0.30.0 

func (o *DeleteOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*DeleteOptions) Validate added in v0.28.0 

func (o *DeleteOptions) Validate(args []string, cxt *portercontext.Context) error

Validate prepares for an installation delete action and validates the args/options.

type DisplayCredentialSet added in v1.0.1 

type DisplayCredentialSet struct {
	// SchemaType helps when we export the definition so editors can detect the type of document, it's not used by porter.
	SchemaType                string `json:"schemaType" yaml:"schemaType"`
	credentials.CredentialSet `yaml:",inline"`
}

type DisplayInstallation added in v0.28.0 

type DisplayInstallation struct {
	// SchemaType helps when we export the definition so editors can detect the type of document, it's not used by porter.
	SchemaType                  string `json:"schemaType" yaml:"schemaType"`
	claims.Installation         `yaml:",inline"`
	DisplayInstallationMetadata `json:"_calculated" yaml:"_calculated"`
}

DisplayInstallation holds a subset of pertinent values to be listed from installation data originating from its claims, results and outputs records

func NewDisplayInstallation added in v0.28.0 

func NewDisplayInstallation(installation claims.Installation, run *claims.Run) DisplayInstallation

type DisplayInstallationMetadata added in v1.0.1 

type DisplayInstallationMetadata struct {
	ResolvedParameters DisplayValues `json:"resolvedParameters", yaml:"resolvedParameters"`
}

type DisplayInstallations added in v0.28.0 

type DisplayInstallations []DisplayInstallation

TODO(carolynvs): be consistent with sorting results from list, either keep the default sort by name or update the other types to also sort by modified

func (DisplayInstallations) Len added in v0.28.0 

func (l DisplayInstallations) Len() int

func (DisplayInstallations) Less added in v0.28.0 

func (l DisplayInstallations) Less(i, j int) bool

func (DisplayInstallations) Swap added in v0.28.0 

func (l DisplayInstallations) Swap(i, j int)

type DisplayParameterSet added in v1.0.1 

type DisplayParameterSet struct {
	// SchemaType helps when we export the definition so editors can detect the type of document, it's not used by porter.
	SchemaType              string `json:"schemaType" yaml:"schemaType"`
	parameters.ParameterSet `yaml:",inline"`
}

type DisplayRun added in v1.0.1 

type DisplayRun struct {
	ClaimID    string                 `json:"claimID" yaml:"claimID"`
	Bundle     string                 `json:"bundle,omitempty" yaml:"bundle,omitempty"`
	Version    string                 `json:"version" yaml:"version"`
	Action     string                 `json:"action" yaml:"action"`
	Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	Started    time.Time              `json:"started" yaml:"started"`
	Stopped    time.Time              `json:"stopped" yaml:"stopped"`
	Status     string                 `json:"status" yaml:"status"`
}

func NewDisplayRun added in v1.0.1 

func NewDisplayRun(run claims.Run) DisplayRun

type DisplayRuns added in v1.0.1 

type DisplayRuns []DisplayRun

func (DisplayRuns) Len added in v1.0.1 

func (l DisplayRuns) Len() int

func (DisplayRuns) Less added in v1.0.1 

func (l DisplayRuns) Less(i, j int) bool

func (DisplayRuns) Swap added in v1.0.1 

func (l DisplayRuns) Swap(i, j int)

type DisplayValue added in v1.0.1 

type DisplayValue struct {
	Name      string      `json:"name" yaml:"name"`
	Type      string      `json:"type" yaml:"type"`
	Sensitive bool        `json:"sensitive" yaml:"sensitive"`
	Value     interface{} `json:"value" yaml:"value"`
}

func (DisplayValue) PrintValue added in v1.0.1 

func (v DisplayValue) PrintValue() string

func (*DisplayValue) SetValue added in v1.0.1 

func (v *DisplayValue) SetValue(value interface{})

type DisplayValues added in v1.0.1 

type DisplayValues []DisplayValue

func NewDisplayValuesFromOutputs added in v1.0.1 

func NewDisplayValuesFromOutputs(bun cnab.ExtendedBundle, outputs claims.Outputs) DisplayValues

func NewDisplayValuesFromParameters added in v1.0.1 

func NewDisplayValuesFromParameters(bun cnab.ExtendedBundle, params map[string]interface{}) DisplayValues

func (DisplayValues) Len added in v1.0.1 

func (v DisplayValues) Len() int

func (DisplayValues) Less added in v1.0.1 

func (v DisplayValues) Less(i, j int) bool

func (DisplayValues) Swap added in v1.0.1 

func (v DisplayValues) Swap(i, j int)

type ExplainOpts 

type ExplainOpts struct {
	BundleActionOptions
	printer.PrintOptions

	Action string
}

func (*ExplainOpts) LoadParameters added in v0.30.0 

func (o *ExplainOpts) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*ExplainOpts) Validate 

func (o *ExplainOpts) Validate(args []string, pctx *portercontext.Context) error

type InspectableBundle 

type InspectableBundle struct {
	Name             string                     `json:"name" yaml:"name"`
	Description      string                     `json:"description,omitempty" yaml:"description,omitempty"`
	Version          string                     `json:"version" yaml:"version"`
	InvocationImages []PrintableInvocationImage `json:"invocationImages" yaml:"invocationImages"`
	Images           []PrintableImage           `json:"images,omitempty" yaml:"images,omitempty"`
}

type InstallOptions 

type InstallOptions struct {
	*BundleActionOptions

	// Labels to apply to the installation.
	Labels []string
}

InstallOptions that may be specified when installing a bundle. Porter handles defaulting any missing values.

func NewInstallOptions added in v0.30.0 

func NewInstallOptions() InstallOptions

func (InstallOptions) GetAction added in v0.30.0 

func (o InstallOptions) GetAction() string

func (InstallOptions) GetActionVerb added in v0.30.0 

func (o InstallOptions) GetActionVerb() string

func (InstallOptions) LoadParameters added in v0.30.0 

func (o InstallOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (InstallOptions) ParseLabels added in v1.0.1 

func (o InstallOptions) ParseLabels() map[string]string

func (InstallOptions) Validate added in v0.38.5 

func (o InstallOptions) Validate(args []string, p *Porter) error

type InvokeOptions 

type InvokeOptions struct {
	// Action name to invoke
	Action string
	*BundleActionOptions
}

InvokeOptions that may be specified when invoking a bundle. Porter handles defaulting any missing values.

func NewInvokeOptions added in v0.30.0 

func NewInvokeOptions() InvokeOptions

func (InvokeOptions) GetAction added in v0.30.0 

func (o InvokeOptions) GetAction() string

func (InvokeOptions) GetActionVerb added in v0.30.0 

func (o InvokeOptions) GetActionVerb() string

func (InvokeOptions) LoadParameters added in v0.30.0 

func (o InvokeOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (InvokeOptions) Validate 

func (o InvokeOptions) Validate(args []string, p *Porter) error

type LintOptions 

type LintOptions struct {
	printer.PrintOptions

	// File path to the porter manifest. Defaults to the bundle in the current directory.
	File string
	// contains filtered or unexported fields
}

func (LintOptions) Apply 

func (o LintOptions) Apply(cxt *portercontext.Context)

func (*LintOptions) Validate 

func (o *LintOptions) Validate(cxt *portercontext.Context) error

type ListOptions 

type ListOptions struct {
	printer.PrintOptions
	AllNamespaces bool
	Namespace     string
	Name          string
	Labels        []string
}

ListOptions represent generic options for use by Porter's list commands

func (ListOptions) GetNamespace added in v1.0.1 

func (o ListOptions) GetNamespace() string

func (ListOptions) ParseLabels added in v1.0.1 

func (o ListOptions) ParseLabels() map[string]string

func (*ListOptions) Validate added in v1.0.1 

func (o *ListOptions) Validate() error

type LogsShowOptions added in v0.35.0 

type LogsShowOptions struct {
	ClaimID string
	// contains filtered or unexported fields
}

LogsShowOptions represent options for an installation logs show command

func (*LogsShowOptions) Installation added in v0.35.0 

func (o *LogsShowOptions) Installation() string

Installation name passed to the command.

func (*LogsShowOptions) LoadParameters added in v0.35.0 

func (o *LogsShowOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*LogsShowOptions) Validate added in v0.35.0 

func (o *LogsShowOptions) Validate(cxt *portercontext.Context) error

Validate validates the provided args, using the provided context, setting attributes of LogsShowOptions as applicable

type Mixins 

type Mixins []mixin.Metadata

func (Mixins) PrintMixinsTable 

func (mixins Mixins) PrintMixinsTable() string

type MixinsCreateOptions added in v1.0.1 

type MixinsCreateOptions struct {
	MixinName      string
	AuthorName     string
	AuthorUsername string
	DirPath        string
}

MixinsCreateOptions represent options for Porter's mixin create command

func (*MixinsCreateOptions) Validate added in v1.0.1 

func (o *MixinsCreateOptions) Validate(args []string, cxt *portercontext.Context) error

type OutputListOptions 

type OutputListOptions struct {
	printer.PrintOptions
	// contains filtered or unexported fields
}

OutputListOptions represent options for a bundle output list command

func (*OutputListOptions) LoadParameters added in v0.30.0 

func (o *OutputListOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*OutputListOptions) Validate 

func (o *OutputListOptions) Validate(args []string, cxt *portercontext.Context) error

Validate validates the provided args, using the provided context, setting attributes of OutputListOptions as applicable

type OutputShowOptions 

type OutputShowOptions struct {
	Output string
	// contains filtered or unexported fields
}

OutputShowOptions represent options for a bundle output show command

func (*OutputShowOptions) LoadParameters added in v0.30.0 

func (o *OutputShowOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*OutputShowOptions) Validate 

func (o *OutputShowOptions) Validate(args []string, cxt *portercontext.Context) error

Validate validates the provided args, using the provided context, setting attributes of OutputShowOptions as applicable

type ParameterDeleteOptions 

type ParameterDeleteOptions struct {
	Name      string
	Namespace string
}

ParameterDeleteOptions represent options for Porter's parameter delete command

func (*ParameterDeleteOptions) Validate 

func (o *ParameterDeleteOptions) Validate(args []string) error

Validate the args provided to the delete parameter command

type ParameterEditOptions 

type ParameterEditOptions struct {
	Name      string
	Namespace string
}

ParameterEditOptions represent iptions for Porter's parameter edit command

func (*ParameterEditOptions) Validate 

func (o *ParameterEditOptions) Validate(args []string) error

Validate validates the args provided to Porter's parameter edit command

type ParameterOptions 

type ParameterOptions struct {
	BundleActionOptions
	Silent bool
	Labels []string
}

ParameterOptions represent generic/base options for a Porter parameters command

func (*ParameterOptions) LoadParameters added in v0.30.0 

func (o *ParameterOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (ParameterOptions) ParseLabels added in v1.0.1 

func (o ParameterOptions) ParseLabels() map[string]string

func (*ParameterOptions) Validate 

func (o *ParameterOptions) Validate(args []string, p *Porter) error

Validate prepares for an action and validates the options. For example, relative paths are converted to full paths and then checked that they exist and are accessible.

type ParameterShowOptions 

type ParameterShowOptions struct {
	printer.PrintOptions
	Name      string
	Namespace string
}

ParameterShowOptions represent options for Porter's parameter show command

func (*ParameterShowOptions) Validate 

func (o *ParameterShowOptions) Validate(args []string) error

Validate validates the args provided to Porter's parameter show command

type Porter 

type Porter struct {
	*config.Config

	Cache       cache.BundleCache
	Credentials credentials.Provider
	Parameters  parameters.Provider
	Claims      claims.Provider
	Registry    cnabtooci.RegistryProvider
	Templates   *templates.Templates
	Mixins      mixin.MixinProvider
	Plugins     plugins.PluginProvider
	CNAB        cnabprovider.CNABProvider
	Secrets     secrets.Store
	Storage     storage.Provider
	// contains filtered or unexported fields
}

Porter is the logic behind the porter client.

func New 

func New() *Porter

New porter client, initialized with useful defaults.

func NewFor added in v1.0.1 

func NewFor(c *config.Config, store storage.Store) *Porter

func (*Porter) Archive 

func (p *Porter) Archive(ctx context.Context, opts ArchiveOptions) error

Archive is a composite function that generates a CNAB thick bundle. It will pull the invocation image, and any referenced images locally (if needed), export them to individual layers, generate a bundle.json and then generate a gzipped tar archive containing the bundle.json and the images

func (*Porter) Build 

func (p *Porter) Build(ctx context.Context, opts BuildOptions) error

func (*Porter) BuildActionArgs added in v0.30.0 

func (p *Porter) BuildActionArgs(ctx context.Context, installation claims.Installation, action BundleAction) (cnabprovider.ActionArguments, error)

BuildActionArgs converts an instance of user-provided action options into prepared arguments that can be used to execute the action.

func (*Porter) Close added in v1.0.1 

func (p *Porter) Close() error

Close releases resources used by Porter before terminating the application.

func (*Porter) Connect added in v1.0.1 

func (p *Porter) Connect(ctx context.Context) error

func (*Porter) CopyBundle 

func (p *Porter) CopyBundle(c *CopyOpts) error

CopyBundle copies a bundle from one repository to another

func (*Porter) CopyTemplate 

func (p *Porter) CopyTemplate(getTemplate func() ([]byte, error), dest string) error

func (*Porter) Create 

func (p *Porter) Create() error

func (*Porter) CreateCredential added in v1.0.1 

func (p *Porter) CreateCredential(opts CredentialCreateOptions) error

func (*Porter) CreateMixin added in v1.0.1 

func (p *Porter) CreateMixin(opts MixinsCreateOptions) error

func (*Porter) CreateMixinFeedTemplate 

func (p *Porter) CreateMixinFeedTemplate() error

func (*Porter) CredentialsApply added in v1.0.1 

func (p *Porter) CredentialsApply(o ApplyOptions) error

func (*Porter) DeleteCredential 

func (p *Porter) DeleteCredential(opts CredentialDeleteOptions) error

DeleteCredential deletes the credential set corresponding to the provided names.

func (*Porter) DeleteInstallation added in v0.28.0 

func (p *Porter) DeleteInstallation(opts DeleteOptions) error

DeleteInstallation handles deletion of an installation

func (*Porter) DeleteParameter 

func (p *Porter) DeleteParameter(opts ParameterDeleteOptions) error

DeleteParameter deletes the parameter set corresponding to the provided names.

func (*Porter) EditCredential 

func (p *Porter) EditCredential(opts CredentialEditOptions) error

EditCredential edits the credentials of the provided name.

func (*Porter) EditParameter 

func (p *Porter) EditParameter(opts ParameterEditOptions) error

EditParameter edits the parameters of the provided name.

func (*Porter) ExecuteAction added in v0.30.0 

func (p *Porter) ExecuteAction(ctx context.Context, installation claims.Installation, action BundleAction) error

ExecuteAction runs the specified action. Supported actions are: install, upgrade, invoke. The uninstall action works in reverse so it's implemented separately.

func (*Porter) Explain 

func (p *Porter) Explain(ctx context.Context, o ExplainOpts) error

func (*Porter) FixPermissions added in v0.38.7 

func (p *Porter) FixPermissions() error

func (*Porter) GenerateCredentials 

func (p *Porter) GenerateCredentials(ctx context.Context, opts CredentialOptions) error

GenerateCredentials builds a new credential set based on the given options. This can be either a silent build, based on the opts.Silent flag, or interactive using a survey. Returns an error if unable to generate credentials

func (*Porter) GenerateMixinFeed 

func (p *Porter) GenerateMixinFeed(opts feed.GenerateOptions) error

func (*Porter) GenerateParameters 

func (p *Porter) GenerateParameters(ctx context.Context, opts ParameterOptions) error

GenerateParameters builds a new parameter set based on the given options. This can be either a silent build, based on the opts.Silent flag, or interactive using a survey. Returns an error if unable to generate parameters

func (*Porter) GetBuilder added in v1.0.1 

func (p *Porter) GetBuilder() build.Builder

NewBuilder creates a Builder based on the current configuration.

func (*Porter) GetInstallation added in v0.35.0 

func (p *Porter) GetInstallation(opts ShowOptions) (claims.Installation, *claims.Run, error)

GetInstallation retrieves information about an installation, including its most recent run.

func (*Porter) GetInstallationLogs added in v0.35.0 

func (p *Porter) GetInstallationLogs(opts *LogsShowOptions) (string, bool, error)

GetInstallationLogs gets logs for an installation, according to the provided options

func (*Porter) GetManifestSchema 

func (p *Porter) GetManifestSchema() (jsonSchema, error)

func (*Porter) GetPlugin 

func (p *Porter) GetPlugin(name string) (*plugins.Metadata, error)

func (*Porter) GetReplacementSchema 

func (p *Porter) GetReplacementSchema() (jsonSchema, error)

func (*Porter) Inspect 

func (p *Porter) Inspect(ctx context.Context, o ExplainOpts) error

func (*Porter) InstallBundle 

func (p *Porter) InstallBundle(ctx context.Context, opts InstallOptions) error

InstallBundle accepts a set of pre-validated InstallOptions and uses them to install a bundle.

func (*Porter) InstallMixin 

func (p *Porter) InstallMixin(opts mixin.InstallOptions) error

func (*Porter) InstallPlugin 

func (p *Porter) InstallPlugin(opts plugins.InstallOptions) error

func (*Porter) InstallationApply added in v1.0.1 

func (p *Porter) InstallationApply(ctx context.Context, opts ApplyOptions) error

func (*Porter) InvokeBundle 

func (p *Porter) InvokeBundle(ctx context.Context, opts InvokeOptions) error

InvokeBundle accepts a set of pre-validated InvokeOptions and uses them to upgrade a bundle.

func (*Porter) IsBundleUpToDate 

func (p *Porter) IsBundleUpToDate(ctx context.Context, opts bundleFileOptions) (bool, error)

IsBundleUpToDate checks the hash of the manifest against the hash in cnab/bundle.json.

func (*Porter) IsInstallationInSync added in v1.0.1 

func (p *Porter) IsInstallationInSync(ctx context.Context, i claims.Installation, lastRun *claims.Run, action BundleAction) (bool, error)

IsInstallationInSync determines if the desired state of the installation matches the state of the installation the last time it was modified.

func (*Porter) Lint 

func (p *Porter) Lint(opts LintOptions) (linter.Results, error)

Lint porter.yaml for any problems and report the results. This calls the mixins to analyze their sections of the manifest.

func (*Porter) ListBundleOutputs 

func (p *Porter) ListBundleOutputs(opts *OutputListOptions) (DisplayValues, error)

ListBundleOutputs lists the outputs for a given bundle according to the provided display format

func (*Porter) ListCredentials 

func (p *Porter) ListCredentials(opts ListOptions) ([]credentials.CredentialSet, error)

ListCredentials lists saved credential sets.

func (*Porter) ListInstallationRuns added in v1.0.1 

func (p *Porter) ListInstallationRuns(opts RunListOptions) (DisplayRuns, error)

func (*Porter) ListInstallations added in v0.28.0 

func (p *Porter) ListInstallations(ctx context.Context, opts ListOptions) ([]claims.Installation, error)

ListInstallations lists installed bundles.

func (*Porter) ListMixins 

func (p *Porter) ListMixins() ([]mixin.Metadata, error)

func (*Porter) ListParameters 

func (p *Porter) ListParameters(opts ListOptions) ([]parameters.ParameterSet, error)

ListParameters lists saved parameter sets.

func (*Porter) ListPlugins 

func (p *Porter) ListPlugins() ([]plugins.Metadata, error)

func (*Porter) MigrateStorage added in v0.28.0 

func (p *Porter) MigrateStorage() error

func (*Porter) ParametersApply added in v1.0.1 

func (p *Porter) ParametersApply(o ApplyOptions) error

func (*Porter) PrintBundleOutputs 

func (p *Porter) PrintBundleOutputs(opts OutputListOptions) error

func (*Porter) PrintCredentials added in v1.0.1 

func (p *Porter) PrintCredentials(opts ListOptions) error

PrintCredentials prints saved credential sets.

func (*Porter) PrintDebugInfo 

func (p *Porter) PrintDebugInfo(ctx *portercontext.Context, opts VersionOpts, metadata pkgmgmt.Metadata) error

func (*Porter) PrintInstallationRuns added in v1.0.1 

func (p *Porter) PrintInstallationRuns(opts RunListOptions) error

func (*Porter) PrintInstallations added in v0.28.0 

func (p *Porter) PrintInstallations(ctx context.Context, opts ListOptions) error

PrintInstallations prints installed bundles.

func (*Porter) PrintLintResults 

func (p *Porter) PrintLintResults(opts LintOptions) error

PrintLintResults lints the manifest and prints the results to the attached output.

func (*Porter) PrintManifestSchema 

func (p *Porter) PrintManifestSchema() error

func (*Porter) PrintMixins 

func (p *Porter) PrintMixins(opts PrintMixinsOptions) error

func (*Porter) PrintPackages 

func (p *Porter) PrintPackages(opts SearchOptions, list pkgmgmt.PackageList) error

PrintPackages prints the provided package list according to the provided options

func (*Porter) PrintParameters added in v1.0.1 

func (p *Porter) PrintParameters(opts ListOptions) error

PrintParameters prints saved parameter sets.

func (*Porter) PrintPlugins 

func (p *Porter) PrintPlugins(opts PrintPluginsOptions) error

func (*Porter) PrintVersion 

func (p *Porter) PrintVersion(opts VersionOpts) error

func (*Porter) Publish 

func (p *Porter) Publish(ctx context.Context, opts PublishOptions) error

Publish is a composite function that publishes an invocation image, rewrites the porter manifest and then regenerates the bundle.json. Finally it publishes the manifest to an OCI registry.

func (*Porter) PullBundle 

func (p *Porter) PullBundle(opts BundlePullOptions) (cache.CachedBundle, error)

PullBundle looks for a given bundle tag in the bundle cache. If it is not found, it is pulled and stored in the cache. The path to the cached bundle is returned.

func (*Porter) ReadBundleOutput 

func (p *Porter) ReadBundleOutput(outputName, installation, namespace string) (string, error)

ReadBundleOutput reads a bundle output from an installation

func (*Porter) ReconcileInstallation added in v1.0.1 

func (p *Porter) ReconcileInstallation(ctx context.Context, opts ReconcileOptions) error

ReconcileInstallation compares the desired state of an installation as stored in the installation record with the current state of the installation. If they are not in sync, the appropriate bundle action is executed to bring them in sync. This is only used for install/upgrade actions triggered by applying a file to an installation. For uninstall or invoke, you should call those directly.

func (*Porter) Run 

func (p *Porter) Run(opts RunOptions) error

func (*Porter) SearchPackages 

func (p *Porter) SearchPackages(opts SearchOptions) error

SearchPackages searches the provided package list according to the provided options

func (*Porter) ShowBundleOutput 

func (p *Porter) ShowBundleOutput(opts *OutputShowOptions) error

ShowBundleOutput shows a bundle output value, according to the provided options

func (*Porter) ShowCredential 

func (p *Porter) ShowCredential(opts CredentialShowOptions) error

ShowCredential shows the credential set corresponding to the provided name, using the provided printer.PrintOptions for display.

func (*Porter) ShowInstallation added in v0.28.0 

func (p *Porter) ShowInstallation(opts ShowOptions) error

ShowInstallation shows a bundle installation, along with any associated outputs

func (*Porter) ShowInstallationLogs added in v0.35.0 

func (p *Porter) ShowInstallationLogs(opts *LogsShowOptions) error

ShowInstallationLogs shows logs for an installation, according to the provided options.

func (*Porter) ShowParameter 

func (p *Porter) ShowParameter(opts ParameterShowOptions) error

ShowParameter shows the parameter set corresponding to the provided name, using the provided printer.PrintOptions for display.

func (*Porter) ShowPlugin 

func (p *Porter) ShowPlugin(opts ShowPluginOptions) error

func (*Porter) UninstallBundle 

func (p *Porter) UninstallBundle(ctx context.Context, opts UninstallOptions) error

UninstallBundle accepts a set of pre-validated UninstallOptions and uses them to uninstall a bundle.

func (*Porter) UninstallMixin 

func (p *Porter) UninstallMixin(opts pkgmgmt.UninstallOptions) error

func (*Porter) UninstallPlugin 

func (p *Porter) UninstallPlugin(opts pkgmgmt.UninstallOptions) error

func (*Porter) UpgradeBundle 

func (p *Porter) UpgradeBundle(ctx context.Context, opts UpgradeOptions) error

UpgradeBundle accepts a set of pre-validated UpgradeOptions and uses them to upgrade a bundle.

type PrintMixinsOptions 

type PrintMixinsOptions struct {
	printer.PrintOptions
}

PrintMixinsOptions represent options for the PrintMixins function

type PrintPluginsOptions 

type PrintPluginsOptions struct {
	printer.PrintOptions
}

PrintPluginsOptions represent options for the PrintPlugins function

type PrintableAction 

type PrintableAction struct {
	Name     string `json:"name" yaml:"name"`
	Modifies bool   `json:"modifies" yaml:"modifies"`
	// Stateless indicates that the action is purely informational, that credentials are not required, and that the runtime should not keep track of its invocation
	Stateless bool `json:"stateless" yaml:"stateless"`
	// Description describes the action as a user-readable string
	Description string `json:"description" yaml:"description"`
}

type PrintableBundle 

type PrintableBundle struct {
	Name          string                `json:"name" yaml:"name"`
	Description   string                `json:"description,omitempty" yaml:"description,omitempty"`
	Version       string                `json:"version" yaml:"version"`
	PorterVersion string                `json:"porterVersion,omitempty" yaml:"porterVersion,omitempty"`
	Parameters    []PrintableParameter  `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	Credentials   []PrintableCredential `json:"credentials,omitempty" yaml:"credentials,omitempty"`
	Outputs       []PrintableOutput     `json:"outputs,omitempty" yaml:"outputs,omitempty"`
	Actions       []PrintableAction     `json:"customActions,omitempty" yaml:"customActions,omitempty"`
	Dependencies  []PrintableDependency `json:"dependencies,omitempty" yaml:"dependencies,omitempty"`
	Mixins        []string              `json:"mixins" yaml:"mixins"`
}

PrintableBundle holds a subset of pertinent values to be explained from a bundle

type PrintableCredential 

type PrintableCredential struct {
	Name        string `json:"name" yaml:"name"`
	Description string `json:"description" yaml:"description"`
	Required    bool   `json:"required" yaml:"required"`
	ApplyTo     string `json:"applyTo" yaml:"applyTo"`
}

type PrintableDependency added in v0.29.0 

type PrintableDependency struct {
	Alias     string `json:"alias" yaml:"alias"`
	Reference string `json:"reference" yaml:"reference"`
}

type PrintableImage 

type PrintableImage struct {
	Name string `json:"name" yaml:"name"`
	bundle.Image
	Original string `json:"originalImage" yaml:"originalImage"`
}

type PrintableInvocationImage 

type PrintableInvocationImage struct {
	bundle.InvocationImage
	Original string `json:"originalImage" yaml:"originalImage"`
}

type PrintableOutput 

type PrintableOutput struct {
	Name        string      `json:"name" yaml:"name"`
	Type        interface{} `json:"type" yaml:"type"`
	ApplyTo     string      `json:"applyTo" yaml:"applyTo"`
	Description string      `json:"description" yaml:"description"`
}

type PrintableParameter 

type PrintableParameter struct {
	Name        string      `json:"name" yaml:"name"`
	Type        interface{} `json:"type" yaml:"type"`
	Default     interface{} `json:"default" yaml:"default"`
	ApplyTo     string      `json:"applyTo" yaml:"applyTo"`
	Description string      `json:"description" yaml:"description"`
	Required    bool        `json:"required" yaml:"required"`
	// contains filtered or unexported fields
}

type PublishOptions 

type PublishOptions struct {
	BundlePullOptions

	Tag         string
	Registry    string
	ArchiveFile string
	// contains filtered or unexported fields
}

PublishOptions are options that may be specified when publishing a bundle. Porter handles defaulting any missing values.

func (*PublishOptions) Validate 

func (o *PublishOptions) Validate(cxt *portercontext.Context) error

Validate performs validation on the publish options

type ReconcileOptions added in v1.0.1 

type ReconcileOptions struct {
	Name         string
	Namespace    string
	Installation claims.Installation

	// Just reapply the installation regardless of what has changed (or not)
	Force bool

	// DryRun only checks if the changes would trigger a bundle run
	DryRun bool
}

type RunListOptions added in v1.0.1 

type RunListOptions struct {
	printer.PrintOptions
	// contains filtered or unexported fields
}

RunListOptions represent options for showing runs of an installation

func (*RunListOptions) LoadParameters 

func (o *RunListOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*RunListOptions) Validate added in v1.0.1 

func (so *RunListOptions) Validate(args []string, cxt *portercontext.Context) error

Validate prepares for the list installation runs action and validates the args/options.

type RunOptions 

type RunOptions struct {
	File   string
	Action string
	// contains filtered or unexported fields
}

func NewRunOptions 

func NewRunOptions(c *config.Config) RunOptions

func (*RunOptions) Validate 

func (o *RunOptions) Validate() error

type SearchOptions 

type SearchOptions struct {
	Name string
	Type string
	printer.PrintOptions
	pkgmgmt.PackageDownloadOptions
}

SearchOptions are options for searching packages

func (*SearchOptions) Validate 

func (o *SearchOptions) Validate(args []string) error

Validate validates the arguments provided to a search command

type ShowOptions 

type ShowOptions struct {
	printer.PrintOptions
	// contains filtered or unexported fields
}

ShowOptions represent options for showing a particular installation

func (*ShowOptions) LoadParameters added in v0.30.0 

func (o *ShowOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (*ShowOptions) Validate 

func (so *ShowOptions) Validate(args []string, cxt *portercontext.Context) error

Validate prepares for a show bundle action and validates the args/options.

type ShowPluginOptions 

type ShowPluginOptions struct {
	printer.PrintOptions
	Name string
}

ShowPluginOptions represent options for showing a particular plugin.

func (*ShowPluginOptions) Validate 

func (o *ShowPluginOptions) Validate(args []string) error

type SortPrintableAction 

type SortPrintableAction []PrintableAction

func (SortPrintableAction) Len 

func (s SortPrintableAction) Len() int

func (SortPrintableAction) Less 

func (s SortPrintableAction) Less(i, j int) bool

func (SortPrintableAction) Swap 

func (s SortPrintableAction) Swap(i, j int)

type SortPrintableCredential 

type SortPrintableCredential []PrintableCredential

func (SortPrintableCredential) Len 

func (s SortPrintableCredential) Len() int

func (SortPrintableCredential) Less 

func (s SortPrintableCredential) Less(i, j int) bool

func (SortPrintableCredential) Swap 

func (s SortPrintableCredential) Swap(i, j int)

type SortPrintableOutput 

type SortPrintableOutput []PrintableOutput

func (SortPrintableOutput) Len 

func (s SortPrintableOutput) Len() int

func (SortPrintableOutput) Less 

func (s SortPrintableOutput) Less(i, j int) bool

func (SortPrintableOutput) Swap 

func (s SortPrintableOutput) Swap(i, j int)

type SortPrintableParameter 

type SortPrintableParameter []PrintableParameter

func (SortPrintableParameter) Len 

func (s SortPrintableParameter) Len() int

func (SortPrintableParameter) Less 

func (s SortPrintableParameter) Less(i, j int) bool

func (SortPrintableParameter) Swap 

func (s SortPrintableParameter) Swap(i, j int)

type SystemDebugInfo 

type SystemDebugInfo struct {
	Version pkgmgmt.PackageMetadata `json:"version"`
	SysInfo SystemInfo              `json:"system"`
	Mixins  Mixins                  `json:"mixins"`
}

type SystemInfo 

type SystemInfo struct {
	OS   string
	Arch string
}

type TestBuildProvider 

type TestBuildProvider struct {
}

func NewTestBuildProvider 

func NewTestBuildProvider() *TestBuildProvider

func (*TestBuildProvider) BuildInvocationImage 

func (t *TestBuildProvider) BuildInvocationImage(ctx context.Context, manifest *manifest.Manifest) error

func (*TestBuildProvider) TagInvocationImage added in v0.31.0 

func (t *TestBuildProvider) TagInvocationImage(ctx context.Context, origTag, newTag string) error

type TestDriver added in v0.28.0 

type TestDriver struct {
	Name     string
	Filepath string
}

type TestPorter 

type TestPorter struct {
	*Porter
	TestConfig      *config.TestConfig
	TestStore       storage.TestStore
	TestClaims      *claims.TestClaimProvider
	TestCredentials *credentials.TestCredentialProvider
	TestParameters  *parameters.TestParameterProvider
	TestCache       *cache.TestCache
	TestRegistry    *cnabtooci.TestRegistry

	// original directory where the test was being executed
	TestDir string

	// directory where the integration test is being executed
	BundleDir string

	// root of the repository
	// Helps us avoid hard coding relative paths from test directories, which easily break when tests are moved
	RepoRoot string

	// The root test context created by NewTestPorter
	RootContext context.Context

	// The root log span created by NewTestPorter
	RootSpan tracing.TraceLogger
}

func NewTestPorter 

func NewTestPorter(t *testing.T) *TestPorter

NewTestPorter initializes a porter test client, with the output buffered, and an in-memory file system.

func (*TestPorter) AddTestBundleDir added in v0.31.0 

func (p *TestPorter) AddTestBundleDir(bundleDir string, generateUniqueName bool) string

AddTestBundleDir into the test bundle directory and give it a unique name to avoid collisions with other tests running in parallel.

func (*TestPorter) AddTestDriver added in v0.28.0 

func (p *TestPorter) AddTestDriver(driver TestDriver) string

func (*TestPorter) AddTestFile added in v0.28.0 

func (p *TestPorter) AddTestFile(src string, dest string)

func (*TestPorter) CompareGoldenFile added in v1.0.1 

func (p *TestPorter) CompareGoldenFile(goldenFile string, got string)

CompareGoldenFile checks if the specified string matches the content of a golden test file. When they are different and PORTER_UPDATE_TEST_FILES is true, the file is updated to match the new test output.

func (*TestPorter) CreateBundleDir 

func (p *TestPorter) CreateBundleDir() string

func (*TestPorter) RandomString added in v0.31.0 

func (p *TestPorter) RandomString(len int) string

func (*TestPorter) ReadBundle added in v0.28.0 

func (p *TestPorter) ReadBundle(path string) cnab.ExtendedBundle

func (*TestPorter) SetupIntegrationTest 

func (p *TestPorter) SetupIntegrationTest()

func (*TestPorter) T 

func (p *TestPorter) T() *testing.T

func (*TestPorter) Teardown 

func (p *TestPorter) Teardown() error

type UninstallDeleteOptions added in v0.28.0 

type UninstallDeleteOptions struct {
	Delete      bool
	ForceDelete bool
}

UninstallDeleteOptions supply options for deletion on uninstall

type UninstallOptions 

type UninstallOptions struct {
	*BundleActionOptions
	UninstallDeleteOptions
}

UninstallOptions that may be specified when uninstalling a bundle. Porter handles defaulting any missing values.

func NewUninstallOptions added in v0.30.0 

func NewUninstallOptions() UninstallOptions

func (UninstallOptions) GetAction added in v0.30.0 

func (o UninstallOptions) GetAction() string

func (UninstallOptions) GetActionVerb added in v0.30.0 

func (o UninstallOptions) GetActionVerb() string

func (UninstallOptions) LoadParameters added in v0.30.0 

func (o UninstallOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

type UpgradeOptions 

type UpgradeOptions struct {
	*BundleActionOptions

	// Version of the bundle to upgrade to
	Version string
}

UpgradeOptions that may be specified when upgrading a bundle. Porter handles defaulting any missing values.

func NewUpgradeOptions added in v0.30.0 

func NewUpgradeOptions() UpgradeOptions

func (UpgradeOptions) GetAction added in v0.30.0 

func (o UpgradeOptions) GetAction() string

func (UpgradeOptions) GetActionVerb added in v0.30.0 

func (o UpgradeOptions) GetActionVerb() string

func (UpgradeOptions) LoadParameters added in v0.30.0 

func (o UpgradeOptions) LoadParameters(p *Porter, bun cnab.ExtendedBundle) error

LoadParameters validates and resolves the parameters and sets. It must be called after porter has loaded the bundle definition.

func (UpgradeOptions) Validate added in v1.0.1 

func (o UpgradeOptions) Validate(args []string, p *Porter) error

type VersionOpts 

type VersionOpts struct {
	version.Options
	System bool
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.