Documentation ¶
Index ¶
- type Action
- type Actions
- type BuildInput
- type Instruction
- type Mixin
- func (m *Mixin) Build(ctx context.Context) error
- func (m *Mixin) Execute(ctx context.Context) error
- func (m *Mixin) Init(ctx context.Context) error
- func (m *Mixin) Install(ctx context.Context) error
- func (m *Mixin) PrintSchema()
- func (m *Mixin) PrintVersion(opts version.Options) error
- func (m *Mixin) Uninstall(ctx context.Context) error
- func (m *Mixin) Upgrade(ctx context.Context) error
- type MixinConfig
- type Output
- type SpinFields
- type Step
- type TestMixin
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct { Name string Steps []Step // using UnmarshalYAML so that we don't need a custom type per action }
func (Action) GetSteps ¶
func (a Action) GetSteps() []builder.ExecutableStep
func (Action) MakeSteps ¶
func (a Action) MakeSteps() interface{}
MakeSteps builds a slice of Step for data to be unmarshaled into.
func (Action) MarshalYAML ¶
MarshalYAML converts the action back to a YAML representation install:
spin: ...
func (*Action) UnmarshalYAML ¶
UnmarshalYAML takes any yaml in this form ACTION: - spin: ... and puts the steps into the Action.Steps field
type Actions ¶
type Actions []Action
Actions is a set of actions, and the steps, passed from Porter.
func (*Actions) UnmarshalYAML ¶
UnmarshalYAML takes chunks of a porter.yaml file associated with this mixin and populates it on the current action set. install:
spin: ... spin: ...
upgrade:
spin: ...
type BuildInput ¶
type BuildInput struct {
Config *MixinConfig
}
BuildInput represents stdin passed to the mixin for the build command.
type Instruction ¶
type Instruction struct { Name string `yaml:"name"` Description string `yaml:"description"` Arguments []string `yaml:"arguments,omitempty"` Outputs []Output `yaml:"outputs,omitempty"` SuppressOutput bool `yaml:"suppress-output,omitempty"` Flags builder.Flags `yaml:"flags,omitempty"` WorkingDir string `yaml:"workingDir, omitempty"` // Allow the user to ignore some errors // Adds the ignoreError functionality from the exec mixin // https://release-v1.porter.sh/mixins/exec/#ignore-error builder.IgnoreErrorHandler `yaml:"ignoreError,omitempty"` SpinFields `yaml:",inline"` }
func (Instruction) GetCommand ¶
func (s Instruction) GetCommand() string
func (Instruction) GetOutputs ¶
func (s Instruction) GetOutputs() []builder.Output
type Mixin ¶
type Mixin struct { runtime.RuntimeConfig ClientVersion string // contains filtered or unexported fields }
func (*Mixin) PrintSchema ¶
func (m *Mixin) PrintSchema()
type MixinConfig ¶
type Output ¶
type Output struct { Name string `yaml:"name"` // See https://porter.sh/mixins/exec/#outputs // TODO: If your mixin doesn't support these output types, you can remove these and the interface assertions above, and from #/definitions/outputs in schema.json JsonPath string `yaml:"jsonPath,omitempty"` FilePath string `yaml:"path,omitempty"` Regex string `yaml:"regex,omitempty"` }
func (Output) GetFilePath ¶
func (Output) GetJsonPath ¶
type SpinFields ¶
type SpinFields struct { FermyonCloud bool `yaml:"fermyonCloud"` PlatformURL string `yaml:"platformURL"` HippoUsername string `yaml:"hippoUsername"` HippoPassword string `yaml:"hippoPassword"` Insecure bool `yaml:"insecure"` BindleUsername string `yaml:"bindleUsername"` BindleServer string `yaml:"bindleServer"` BindlePassword string `yaml:"bindlePassword"` }
type Step ¶
type Step struct {
Instruction `yaml:"spin"`
}
func (Step) GetArguments ¶
func (Step) GetWorkingDir ¶
type TestMixin ¶
type TestMixin struct { *Mixin TestContext *portercontext.TestContext }
func NewTestMixin ¶
NewTestMixin initializes a mixin test client, with the output buffered, and an in-memory file system.
Click to show internal directories.
Click to hide internal directories.