tasks

package

Go to main page

Versions in this module

v0

v0.11.0

Oct 22, 2026

Changes in this version

+ const DiagnosticReasonCommandFailed

+ const DiagnosticReasonCommandNotRun

+ const DiagnosticReasonError

+ const DiagnosticReasonObjectMissing

+ const DiagnosticReasonSSH

+ const DiagnosticReasonStateUnreadable

+ const DiagnosticReasonVersion

+ func ContextWithoutObserved(ctx context.Context) context.Context

+ func EscapeProse(s string) string

+ func NewSession(masker *subprocess.Masker, opts ...subprocess.SessionOption) *subprocess.Session

+ func ParseFieldDefault(fieldType, itemType, raw string) (any, error)

+ func TaskTypeOf(t Task) string

+ func TaskValues(t Task) map[string]any

type AppCloneTaskExample

+ Requires []Task

+ func (e AppCloneTaskExample) GetRequires() []Task

+ type ConstraintOption func(*constraintCheck)

+ func WithUnknown(paths ...string) ConstraintOption

+ type Diagnostic struct

+ Detail string

+ ExitCode int

+ Message string

+ Reason string

+ Severity DiagnosticSeverity

+ Stderr string

+ Stdout string

+ Summary string

+ func Diagnostics(ctx context.Context, result any) []Diagnostic

+ type DiagnosticSeverity string

+ const DiagnosticError

+ const DiagnosticWarning

type Doc

+ Requires []Task

+ type ExampleRequirementSchema struct

+ Type string

+ YAML string

+ type ExampleRequirer interface

+ GetRequires func() []Task

type ExampleSchema

+ Requires []ExampleRequirementSchema

type ExportResult

+ func GatedExportRecipe(ctx context.Context, opts ExportOptions) (*ExportResult, error)

+ type FieldNoteSchema struct

+ States map[string]string

+ Suffix string

type FieldSchema

+ Note *FieldNoteSchema

+ Unique bool

type HttpAuthAllowedIpTaskExample

+ Requires []Task

+ func (e HttpAuthAllowedIpTaskExample) GetRequires() []Task

type HttpAuthDomainTaskExample

+ Requires []Task

+ func (e HttpAuthDomainTaskExample) GetRequires() []Task

type HttpAuthUserTaskExample

+ Requires []Task

+ func (e HttpAuthUserTaskExample) GetRequires() []Task

type LetsencryptTaskExample

+ Requires []Task

+ func (e LetsencryptTaskExample) GetRequires() []Task

+ type LifecycleDocer interface

+ Lifecycle func() LifecycleSchema

+ type LifecycleSchema struct

+ Apply State

+ Teardown State

+ func TaskLifecycle(t Task) LifecycleSchema

type NetworkPropertyTaskExample

+ Requires []Task

+ func (e NetworkPropertyTaskExample) GetRequires() []Task

+ type NoteKind string

+ const NoteConstraints

+ const NoteDeprecation

+ const NoteExport

+ const NoteIdentity

+ const NoteImperative

+ const NoteLifecycle

+ const NoteObjects

+ const NoteProbe

+ const NoteProperties

+ const NoteRequirements

+ const NoteRunnerRequirements

+ type NoteSchema struct

+ Kind NoteKind

+ Markdown string

+ States map[string]string

type SchedulerK3sNodeSysctlsTaskExample

+ Requires []Task

+ func (e SchedulerK3sNodeSysctlsTaskExample) GetRequires() []Task

type ServiceLinkTaskExample

+ Requires []Task

+ func (e ServiceLinkTaskExample) GetRequires() []Task

type StorageEnsureTask

+ func (t StorageEnsureTask) Lifecycle() LifecycleSchema

type StorageMountTaskExample

+ Requires []Task

+ func (e StorageMountTaskExample) GetRequires() []Task

type Task

+ func TaskFromValues(typeKey string, values map[string]any) (Task, error)

+ func TaskInState(t Task, state State) (Task, error)

+ func TaskRequires(t Task) []Task

type TaskOutputState

+ Exists bool

+ Observed Task

type TaskSchema

+ Lifecycle LifecycleSchema

+ Notes []NoteSchema

v0.10.2

Oct 21, 2026

v0.10.1

Oct 21, 2026

Changes in this version

+ var ErrObjectMissing = errors.New("an object the task depends on does not exist")

+ type ObjectMissingError struct

+ Object TaskObject

+ func (e *ObjectMissingError) Error() string

+ func (e *ObjectMissingError) Is(target error) bool

v0.10.0

Oct 21, 2026

Changes in this version

+ var ConstraintKinds = []ConstraintKind

+ func ContextWithTaskLocks(ctx context.Context) context.Context

+ func LockTask(ctx context.Context, t Task) (context.Context, func(), error)

+ func SessionTaskLocks() subprocess.SessionOption

+ func SessionVersionGate() subprocess.SessionOption

+ func TaskImperative(t Task) bool

type AppCloneTask

+ func (t AppCloneTask) Imperative() bool

+ func (t AppCloneTask) ObjectEffects() ObjectEffects

type AppJsonPropertyTask

+ func (t AppJsonPropertyTask) Constraints() []Constraint

type AppTask

+ func (t AppTask) ObjectEffects() ObjectEffects

type AppsPropertyTask

+ func (t AppsPropertyTask) Constraints() []Constraint

type BuilderDockerfilePropertyTask

+ func (t BuilderDockerfilePropertyTask) Constraints() []Constraint

type BuilderHerokuishPropertyTask

+ func (t BuilderHerokuishPropertyTask) Constraints() []Constraint

type BuilderLambdaPropertyTask

+ func (t BuilderLambdaPropertyTask) Constraints() []Constraint

type BuilderNixpacksPropertyTask

+ func (t BuilderNixpacksPropertyTask) Constraints() []Constraint

type BuilderPackPropertyTask

+ func (t BuilderPackPropertyTask) Constraints() []Constraint

type BuilderPropertyTask

+ func (t BuilderPropertyTask) Constraints() []Constraint

type BuilderRailpackPropertyTask

+ func (t BuilderRailpackPropertyTask) Constraints() []Constraint

type BuildpacksPropertyTask

+ func (t BuildpacksPropertyTask) Constraints() []Constraint

type BuildsPropertyTask

+ func (t BuildsPropertyTask) Constraints() []Constraint

type CaddyPropertyTask

+ func (t CaddyPropertyTask) Constraints() []Constraint

type CertsTask

+ func (t CertsTask) Constraints() []Constraint

type ChecksPropertyTask

+ func (t ChecksPropertyTask) Constraints() []Constraint

type ConfigTask

+ func (t ConfigTask) ObjectEffects() ObjectEffects

+ type Constraint struct

+ Field string

+ Fields []string

+ Kind ConstraintKind

+ States []State

+ func TaskConstraints(v any) []Constraint

+ type ConstraintDocer interface

+ Constraints func() []Constraint

+ type ConstraintKind string

+ const ConstraintAllOrNoneOf

+ const ConstraintAtLeastOneOf

+ const ConstraintConflictsWith

+ const ConstraintExactlyOneOf

+ const ConstraintRequiredWith

+ func (k ConstraintKind) Directional() bool

type CronPropertyTask

+ func (t CronPropertyTask) Constraints() []Constraint

type DomainsTask

+ func (t DomainsTask) Constraints() []Constraint

type DomainsToggleTask

+ func (t DomainsToggleTask) ObjectEffects() ObjectEffects

type FieldSchema

+ ForbiddenWhen []string

+ RequiredWhen []string

type GitFromArchiveTask

+ func (t GitFromArchiveTask) Constraints() []Constraint

+ func (t GitFromArchiveTask) Imperative() bool

+ func (t GitFromArchiveTask) ObjectEffects() ObjectEffects

type GitFromImageTask

+ func (t GitFromImageTask) Constraints() []Constraint

+ func (t GitFromImageTask) Imperative() bool

+ func (t GitFromImageTask) ObjectEffects() ObjectEffects

type GitPropertyTask

+ func (t GitPropertyTask) Constraints() []Constraint

type GitSyncTask

+ func (t GitSyncTask) Imperative() bool

+ func (t GitSyncTask) ObjectEffects() ObjectEffects

type HaproxyPropertyTask

+ func (t HaproxyPropertyTask) Constraints() []Constraint

type HttpAuthTask

+ func (t HttpAuthTask) Constraints() []Constraint

type HttpAuthUser

+ func (u HttpAuthUser) Constraints() []Constraint

+ type ImperativeDocer interface

+ Imperative func() bool

type ItemSchema

+ Constraints []Constraint

type LetsencryptPropertyTask

+ func (t LetsencryptPropertyTask) Constraints() []Constraint

type LogsPropertyTask

+ func (t LogsPropertyTask) Constraints() []Constraint

type MaintenanceCustomPageTask

+ func (t MaintenanceCustomPageTask) Constraints() []Constraint

type NetworkPropertyTask

+ func (t NetworkPropertyTask) Constraints() []Constraint

type NginxPropertyTask

+ func (t NginxPropertyTask) Constraints() []Constraint

+ type ObjectEffects struct

+ Creates []ObjectKind

+ Restarts []ObjectRestart

+ type ObjectEffectsDocer interface

+ ObjectEffects func() ObjectEffects

+ type ObjectKind string

+ const ObjectApp

+ const ObjectService

+ type ObjectRestart struct

+ Kind ObjectKind

+ type ObjectSchema struct

+ Creates bool

+ Keys []string

+ Kind ObjectKind

+ Restarts *Restart

type OpenrestyPropertyTask

+ func (t OpenrestyPropertyTask) Constraints() []Constraint

type Problem

+ Field string

type ProxyPropertyTask

+ func (t ProxyPropertyTask) Constraints() []Constraint

type ProxyToggleTask

+ func (t ProxyToggleTask) ObjectEffects() ObjectEffects

type PsPropertyTask

+ func (t PsPropertyTask) Constraints() []Constraint

type PsScaleTask

+ func (t PsScaleTask) ObjectEffects() ObjectEffects

type RegistryAuthTask

+ func (t RegistryAuthTask) Constraints() []Constraint

type RegistryPropertyTask

+ func (t RegistryPropertyTask) Constraints() []Constraint

+ type Restart struct

+ States []State

+ Unless []string

+ When []string

type SchedulerDockerLocalPropertyTask

+ func (t SchedulerDockerLocalPropertyTask) Constraints() []Constraint

type SchedulerK3sAnnotationsTask

+ func (t SchedulerK3sAnnotationsTask) Constraints() []Constraint

type SchedulerK3sAutoscalingAuthTask

+ func (t SchedulerK3sAutoscalingAuthTask) Constraints() []Constraint

type SchedulerK3sLabelsTask

+ func (t SchedulerK3sLabelsTask) Constraints() []Constraint

type SchedulerK3sNodeSysctlsTask

+ func (t SchedulerK3sNodeSysctlsTask) Constraints() []Constraint

type SchedulerK3sPropertyTask

+ func (t SchedulerK3sPropertyTask) Constraints() []Constraint

type SchedulerPropertyTask

+ func (t SchedulerPropertyTask) Constraints() []Constraint

type ServiceBackupTask

+ func (t ServiceBackupTask) Constraints() []Constraint

type ServiceCreateTask

+ func (t ServiceCreateTask) ObjectEffects() ObjectEffects

type ServiceLinkTask

+ func (t ServiceLinkTask) ObjectEffects() ObjectEffects

type StorageMount

+ func (m StorageMount) Constraints() []Constraint

type StorageMountTask

+ func (t StorageMountTask) Constraints() []Constraint

type Task

+ func ReadAddress(ctx context.Context, address string) (Task, bool, error)

+ type TaskObject struct

+ Creates bool

+ Keys []string

+ Kind ObjectKind

+ Restarts *Restart

+ Set bool

+ Values []string

+ func TaskObjects(t Task) []TaskObject

type TaskSchema

+ Constraints []Constraint

+ Imperative bool

+ Objects []ObjectSchema

type TraefikPropertyTask

+ func (t TraefikPropertyTask) Constraints() []Constraint

+ type Violation struct

+ Field string

+ Message string

+ func ConstraintViolations(task any) []Violation

+ func (v Violation) Error() string

v0.9.2

Oct 16, 2026

Changes in this version

+ var ErrStateUnreadable = errors.New("the task's current state cannot be read")

type PlanResult

+ Exists bool

+ Observed Task

type Task

+ func ReadTask(ctx context.Context, t Task) (Task, bool, error)

v0.9.1

Oct 16, 2026

Changes in this version

+ func TaskSensitiveValues(t Task) []string

type ExportOptions

+ IgnoreVersion bool

type ExportReport

+ VersionErrors []*VersionError

type FieldSchema

+ ApplyOnly bool

+ Ordered *bool

+ WriteOnly bool

type Play

+ SSHIdentityFile *string

+ SSHOptions []string

type RecipeEntry

+ SSHIdentityFile *string

+ SSHOptions []string

+ type VersionError struct

+ Err error

+ Found string

+ Minimum string

+ Plugin string

+ TaskType string

+ func (e *VersionError) Error() string

+ func (e *VersionError) Unwrap() error

v0.9.0

Oct 14, 2026

Changes in this version

+ const CatalogVersion

+ const FormatNameHCL

+ const FormatNameJSON5

+ const FormatYAML

+ const IdentityRoleCollection

+ const IdentityRoleKey

+ const PropertyFieldName

+ const PropertyScopeApp

+ const PropertyScopeGlobal

+ const TypeAny

+ const TypeBool

+ const TypeDict

+ const TypeFloat

+ const TypeInt

+ const TypeList

+ const TypeObject

+ const TypeString

+ const TypeUnknown

+ const WarnReasonProbeIndeterminate

+ const WarnReasonProbeRejected

+ const WarnReasonServiceImageDrift

+ const WarnReasonServiceOptionDrift

+ const WarnReasonUnknownProperty

+ var InputBoolFalseSpellings = []string

+ var InputBoolTrueSpellings = []string

+ var InputTypeNames = []string

+ var ReservedInputNames = map[string]bool

+ func As[T Task](e ExportedTask) (T, bool)

+ func BuildPerPlayContext(base map[string]interface{}, playInputs []Input, userSet map[string]bool) map[string]interface

+ func CanonicalInputType(t string) (string, bool)

+ func CheckMinimumVersions(ctx context.Context, typeKey string, task Task) error

+ func CodecExtensions() []string

+ func CodecNames() []string

+ func CollectEnvelopeNames(envs []*TaskEnvelope) []string

+ func CollectPlaySensitiveValues(plays []*Play) []string

+ func CollectSensitiveValues(tasks OrderedStringEnvelopeMap) []string

+ func CompilePredicate(src string) (*vm.Program, error)

+ func ContextWithVersionGate(ctx context.Context) context.Context

+ func Convert(data []byte, from, to Codec) ([]byte, error)

+ func DoubleQuoteEscape(v interface{}) (string, error)

+ func EnvelopeContainsName(env *TaskEnvelope, target string) bool

+ func EnvelopePassesTags(env *TaskEnvelope, includes, skips []string) bool

+ func EvalBool(prog *vm.Program, env map[string]interface{}) (bool, error)

+ func EvalList(prog *vm.Program, env map[string]interface{}) ([]interface{}, error)

+ func FileLevelInputNames(plays []*Play) map[string]bool

+ func FilterByTags(m OrderedStringEnvelopeMap, includes, skips []string) []string

+ func Format(data []byte) ([]byte, error)

+ func FormatHCL(data []byte) ([]byte, error)

+ func FormatJSON5(data []byte) ([]byte, error)

+ func HCLDoubleQuoteEscape(v interface{}) (string, error)

+ func HCLScalar(v interface{}) (string, error)

+ func IdentityAddress(typeKey string, t Task) string

+ func IdentityKeyNames(t Task) []string

+ func IdentityMatches(t Task, want map[string]string) bool

+ func InvalidatePluginVersions(ctx context.Context)

+ func JSONScalar(v interface{}) (string, error)

+ func ParseIdentityAddress(address string) (string, map[string]string, error)

+ func ParseInputBool(s string) (bool, bool)

+ func ParseInputFloat(s string) (float64, bool)

+ func ParseInputInt(s string) (int, bool)

+ func PredicateIdentifiers(src string) (map[string]bool, error)

+ func RegisterTask(t Task)

+ func RenderTemplate(input []byte, vars map[string]interface{}, name string) (bytes.Buffer, error)

+ func RenderTemplateWithFormat(input []byte, vars map[string]interface{}, name, format string) (bytes.Buffer, error)

+ func TaskDeprecation(t Task) string

+ func TaskSynopsis(t Task) string

+ func TaskTypes() []string

+ func YAMLScalar(v interface{}) (string, error)

+ type AclAppTask struct

+ App string

+ State State

+ Users []string

+ func (t AclAppTask) Doc() string

+ func (t AclAppTask) Execute(ctx context.Context) TaskOutputState

+ func (t AclAppTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t AclAppTask) ExportSupport() ExportSupport

+ func (t AclAppTask) MinimumVersions() VersionSupport

+ func (t AclAppTask) Plan(ctx context.Context) PlanResult

+ func (t AclAppTask) ProbeSupport() ProbeSupport

+ func (t AclAppTask) Validate() error

+ type AclAppTaskExample struct

+ AclAppTask AclAppTask

+ Name string

+ func (e AclAppTaskExample) GetName() string

+ type AclServiceTask struct

+ Service string

+ State State

+ Type string

+ Users []string

+ func (t AclServiceTask) Doc() string

+ func (t AclServiceTask) Execute(ctx context.Context) TaskOutputState

+ func (t AclServiceTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t AclServiceTask) ExportSupport() ExportSupport

+ func (t AclServiceTask) MinimumVersions() VersionSupport

+ func (t AclServiceTask) Plan(ctx context.Context) PlanResult

+ func (t AclServiceTask) ProbeSupport() ProbeSupport

+ func (t AclServiceTask) Validate() error

+ type AclServiceTaskExample struct

+ AclServiceTask AclServiceTask

+ Name string

+ func (e AclServiceTaskExample) GetName() string

+ type AppCloneTask struct

+ App string

+ SkipDeploy bool

+ SourceApp string

+ State State

+ func (t AppCloneTask) Doc() string

+ func (t AppCloneTask) Execute(ctx context.Context) TaskOutputState

+ func (t AppCloneTask) ExportSupport() ExportSupport

+ func (t AppCloneTask) MinimumVersions() VersionSupport

+ func (t AppCloneTask) Plan(ctx context.Context) PlanResult

+ func (t AppCloneTask) ProbeSupport() ProbeSupport

+ func (t AppCloneTask) Validate() error

+ type AppCloneTaskExample struct

+ AppCloneTask AppCloneTask

+ Name string

+ func (e AppCloneTaskExample) GetName() string

+ type AppDeploySource struct

+ Source string

+ SourceMetadata string

+ type AppExporter interface

+ ExportApp func(ctx context.Context, app string) ([]interface{}, error)

+ type AppJsonPropertyTask PropertyFields

+ func (t AppJsonPropertyTask) Doc() string

+ func (t AppJsonPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t AppJsonPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t AppJsonPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t AppJsonPropertyTask) ExportSupport() ExportSupport

+ func (t AppJsonPropertyTask) MinimumVersions() VersionSupport

+ func (t AppJsonPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t AppJsonPropertyTask) ProbeSupport() ProbeSupport

+ func (t AppJsonPropertyTask) Validate() error

+ type AppJsonPropertyTaskExample struct

+ AppJsonPropertyTask AppJsonPropertyTask

+ Name string

+ func (e AppJsonPropertyTaskExample) GetName() string

+ type AppLockTask struct

+ App string

+ State State

+ func (t AppLockTask) Doc() string

+ func (t AppLockTask) Execute(ctx context.Context) TaskOutputState

+ func (t AppLockTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t AppLockTask) ExportSupport() ExportSupport

+ func (t AppLockTask) MinimumVersions() VersionSupport

+ func (t AppLockTask) Plan(ctx context.Context) PlanResult

+ func (t AppLockTask) ProbeSupport() ProbeSupport

+ type AppLockTaskExample struct

+ AppLockTask AppLockTask

+ Name string

+ func (e AppLockTaskExample) GetName() string

+ type AppTask struct

+ App string

+ State State

+ func (t AppTask) Doc() string

+ func (t AppTask) Execute(ctx context.Context) TaskOutputState

+ func (t AppTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t AppTask) ExportSupport() ExportSupport

+ func (t AppTask) MinimumVersions() VersionSupport

+ func (t AppTask) Plan(ctx context.Context) PlanResult

+ func (t AppTask) ProbeSupport() ProbeSupport

+ type AppTaskExample struct

+ DokkuApp AppTask

+ Name string

+ func (e AppTaskExample) GetName() string

+ type AppsPropertyTask PropertyFields

+ func (t AppsPropertyTask) Doc() string

+ func (t AppsPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t AppsPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t AppsPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t AppsPropertyTask) ExportSupport() ExportSupport

+ func (t AppsPropertyTask) MinimumVersions() VersionSupport

+ func (t AppsPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t AppsPropertyTask) ProbeSupport() ProbeSupport

+ func (t AppsPropertyTask) Validate() error

+ type AppsPropertyTaskExample struct

+ AppsPropertyTask AppsPropertyTask

+ Name string

+ func (e AppsPropertyTaskExample) GetName() string

+ type BuilderDockerfilePropertyTask PropertyFields

+ func (t BuilderDockerfilePropertyTask) Doc() string

+ func (t BuilderDockerfilePropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderDockerfilePropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderDockerfilePropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderDockerfilePropertyTask) ExportSupport() ExportSupport

+ func (t BuilderDockerfilePropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderDockerfilePropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderDockerfilePropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderDockerfilePropertyTask) Validate() error

+ type BuilderDockerfilePropertyTaskExample struct

+ BuilderDockerfilePropertyTask BuilderDockerfilePropertyTask

+ Name string

+ func (e BuilderDockerfilePropertyTaskExample) GetName() string

+ type BuilderHerokuishPropertyTask PropertyFields

+ func (t BuilderHerokuishPropertyTask) Doc() string

+ func (t BuilderHerokuishPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderHerokuishPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderHerokuishPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderHerokuishPropertyTask) ExportSupport() ExportSupport

+ func (t BuilderHerokuishPropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderHerokuishPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderHerokuishPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderHerokuishPropertyTask) Validate() error

+ type BuilderHerokuishPropertyTaskExample struct

+ BuilderHerokuishPropertyTask BuilderHerokuishPropertyTask

+ Name string

+ func (e BuilderHerokuishPropertyTaskExample) GetName() string

+ type BuilderLambdaPropertyTask PropertyFields

+ func (t BuilderLambdaPropertyTask) Doc() string

+ func (t BuilderLambdaPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderLambdaPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderLambdaPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderLambdaPropertyTask) ExportSupport() ExportSupport

+ func (t BuilderLambdaPropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderLambdaPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderLambdaPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderLambdaPropertyTask) Validate() error

+ type BuilderLambdaPropertyTaskExample struct

+ BuilderLambdaPropertyTask BuilderLambdaPropertyTask

+ Name string

+ func (e BuilderLambdaPropertyTaskExample) GetName() string

+ type BuilderNixpacksPropertyTask PropertyFields

+ func (t BuilderNixpacksPropertyTask) Doc() string

+ func (t BuilderNixpacksPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderNixpacksPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderNixpacksPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderNixpacksPropertyTask) ExportSupport() ExportSupport

+ func (t BuilderNixpacksPropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderNixpacksPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderNixpacksPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderNixpacksPropertyTask) Validate() error

+ type BuilderNixpacksPropertyTaskExample struct

+ BuilderNixpacksPropertyTask BuilderNixpacksPropertyTask

+ Name string

+ func (e BuilderNixpacksPropertyTaskExample) GetName() string

+ type BuilderPackPropertyTask PropertyFields

+ func (t BuilderPackPropertyTask) Doc() string

+ func (t BuilderPackPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderPackPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderPackPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderPackPropertyTask) ExportSupport() ExportSupport

+ func (t BuilderPackPropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderPackPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderPackPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderPackPropertyTask) Validate() error

+ type BuilderPackPropertyTaskExample struct

+ BuilderPackPropertyTask BuilderPackPropertyTask

+ Name string

+ func (e BuilderPackPropertyTaskExample) GetName() string

+ type BuilderPropertyTask PropertyFields

+ func (t BuilderPropertyTask) Doc() string

+ func (t BuilderPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderPropertyTask) ExportSupport() ExportSupport

+ func (t BuilderPropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderPropertyTask) Validate() error

+ type BuilderPropertyTaskExample struct

+ BuilderPropertyTask BuilderPropertyTask

+ Name string

+ func (e BuilderPropertyTaskExample) GetName() string

+ type BuilderRailpackPropertyTask PropertyFields

+ func (t BuilderRailpackPropertyTask) Doc() string

+ func (t BuilderRailpackPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuilderRailpackPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuilderRailpackPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuilderRailpackPropertyTask) ExportSupport() ExportSupport

+ func (t BuilderRailpackPropertyTask) MinimumVersions() VersionSupport

+ func (t BuilderRailpackPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuilderRailpackPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuilderRailpackPropertyTask) Validate() error

+ type BuilderRailpackPropertyTaskExample struct

+ BuilderRailpackPropertyTask BuilderRailpackPropertyTask

+ Name string

+ func (e BuilderRailpackPropertyTaskExample) GetName() string

+ type BuildpacksPropertyTask PropertyFields

+ func (t BuildpacksPropertyTask) Doc() string

+ func (t BuildpacksPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuildpacksPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuildpacksPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuildpacksPropertyTask) ExportSupport() ExportSupport

+ func (t BuildpacksPropertyTask) MinimumVersions() VersionSupport

+ func (t BuildpacksPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuildpacksPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuildpacksPropertyTask) Validate() error

+ type BuildpacksPropertyTaskExample struct

+ BuildpacksPropertyTask BuildpacksPropertyTask

+ Name string

+ func (e BuildpacksPropertyTaskExample) GetName() string

+ type BuildpacksTask struct

+ App string

+ Buildpacks []string

+ State State

+ func (t BuildpacksTask) Doc() string

+ func (t BuildpacksTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuildpacksTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuildpacksTask) ExportSupport() ExportSupport

+ func (t BuildpacksTask) MinimumVersions() VersionSupport

+ func (t BuildpacksTask) Plan(ctx context.Context) PlanResult

+ func (t BuildpacksTask) ProbeSupport() ProbeSupport

+ func (t BuildpacksTask) Validate() error

+ type BuildpacksTaskExample struct

+ BuildpacksTask BuildpacksTask

+ Name string

+ func (e BuildpacksTaskExample) GetName() string

+ type BuildsPropertyTask PropertyFields

+ func (t BuildsPropertyTask) Doc() string

+ func (t BuildsPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t BuildsPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t BuildsPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t BuildsPropertyTask) ExportSupport() ExportSupport

+ func (t BuildsPropertyTask) MinimumVersions() VersionSupport

+ func (t BuildsPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t BuildsPropertyTask) ProbeSupport() ProbeSupport

+ func (t BuildsPropertyTask) Validate() error

+ type BuildsPropertyTaskExample struct

+ BuildsPropertyTask BuildsPropertyTask

+ Name string

+ func (e BuildsPropertyTaskExample) GetName() string

+ type CaddyPropertyTask PropertyFields

+ func (t CaddyPropertyTask) Doc() string

+ func (t CaddyPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t CaddyPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t CaddyPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t CaddyPropertyTask) ExportSupport() ExportSupport

+ func (t CaddyPropertyTask) MinimumVersions() VersionSupport

+ func (t CaddyPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t CaddyPropertyTask) ProbeSupport() ProbeSupport

+ func (t CaddyPropertyTask) Validate() error

+ type CaddyPropertyTaskExample struct

+ CaddyPropertyTask CaddyPropertyTask

+ Name string

+ func (e CaddyPropertyTaskExample) GetName() string

+ type CertsTask struct

+ App string

+ Cert string

+ CertContent string

+ Global bool

+ Key string

+ KeyContent string

+ State State

+ func (t CertsTask) Doc() string

+ func (t CertsTask) Execute(ctx context.Context) TaskOutputState

+ func (t CertsTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t CertsTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t CertsTask) ExportSupport() ExportSupport

+ func (t CertsTask) MinimumVersions() VersionSupport

+ func (t CertsTask) Plan(ctx context.Context) PlanResult

+ func (t CertsTask) ProbeSupport() ProbeSupport

+ func (t CertsTask) Validate() error

+ type CertsTaskExample struct

+ CertsTask CertsTask

+ Name string

+ func (e CertsTaskExample) GetName() string

+ type ChecksPropertyTask PropertyFields

+ func (t ChecksPropertyTask) Doc() string

+ func (t ChecksPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t ChecksPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ChecksPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t ChecksPropertyTask) ExportSupport() ExportSupport

+ func (t ChecksPropertyTask) MinimumVersions() VersionSupport

+ func (t ChecksPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t ChecksPropertyTask) ProbeSupport() ProbeSupport

+ func (t ChecksPropertyTask) Validate() error

+ type ChecksPropertyTaskExample struct

+ ChecksPropertyTask ChecksPropertyTask

+ Name string

+ func (e ChecksPropertyTaskExample) GetName() string

+ type ChecksToggleTask ToggleFields

+ func (t ChecksToggleTask) Doc() string

+ func (t ChecksToggleTask) Execute(ctx context.Context) TaskOutputState

+ func (t ChecksToggleTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ChecksToggleTask) ExportSupport() ExportSupport

+ func (t ChecksToggleTask) MinimumVersions() VersionSupport

+ func (t ChecksToggleTask) Plan(ctx context.Context) PlanResult

+ func (t ChecksToggleTask) ProbeSupport() ProbeSupport

+ type ChecksToggleTaskExample struct

+ ChecksToggleTask ChecksToggleTask

+ Name string

+ func (e ChecksToggleTaskExample) GetName() string

+ type Codec interface

+ Aliases func() []string

+ DecodeDocument func(data []byte) (*yaml.Node, error)

+ DoubleQuotesOnly func() bool

+ EncodeDocument func(doc *yaml.Node) ([]byte, error)

+ EscapeDoubleQuoted func(v interface{}) (string, error)

+ Extensions func() []string

+ Format func(data []byte) ([]byte, error)

+ Lint func(data []byte) []Problem

+ Marshal func(v interface{}) ([]byte, error)

+ MarshalVars func(v interface{}) ([]byte, error)

+ Name func() string

+ Sniff func(data []byte) bool

+ ToYAML func(data []byte) ([]byte, *Problem)

+ UnmarshalVars func(data []byte) (map[string]interface{}, error)

+ func CodecFor(format string) Codec

+ func CodecForExtension(ext string) (Codec, bool)

+ func Codecs() []Codec

+ func DefaultCodec() Codec

+ func LookupCodec(spelling string) (Codec, bool)

+ func SniffCodec(data []byte) Codec

+ type ConfigTask struct

+ App string

+ Config map[string]string

+ Preserve []string

+ Restart *bool

+ State State

+ func (t ConfigTask) Doc() string

+ func (t ConfigTask) Execute(ctx context.Context) TaskOutputState

+ func (t ConfigTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ConfigTask) ExportSupport() ExportSupport

+ func (t ConfigTask) MinimumVersions() VersionSupport

+ func (t ConfigTask) Plan(ctx context.Context) PlanResult

+ func (t ConfigTask) ProbeSupport() ProbeSupport

+ func (t ConfigTask) SensitiveValues() []string

+ func (t ConfigTask) Validate() error

+ type ConfigTaskExample struct

+ ConfigTask ConfigTask

+ Name string

+ func (e ConfigTaskExample) GetName() string

+ type CronPropertyTask PropertyFields

+ func (t CronPropertyTask) Doc() string

+ func (t CronPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t CronPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t CronPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t CronPropertyTask) ExportSupport() ExportSupport

+ func (t CronPropertyTask) MinimumVersions() VersionSupport

+ func (t CronPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t CronPropertyTask) ProbeSupport() ProbeSupport

+ func (t CronPropertyTask) Validate() error

+ type CronPropertyTaskExample struct

+ CronPropertyTask CronPropertyTask

+ Name string

+ func (e CronPropertyTaskExample) GetName() string

+ type DeprecationDocer interface

+ Deprecation func() string

+ type Doc struct

+ Codeblock string

+ Name string

+ func MarshalExamples[T TaskExample](examples []T) ([]Doc, error)

+ func TaskExamples(t Task) ([]Doc, error)

+ type DockerOptionsTask struct

+ App string

+ Option string

+ Phase string

+ ProcessType string

+ State State

+ func (t DockerOptionsTask) Doc() string

+ func (t DockerOptionsTask) Execute(ctx context.Context) TaskOutputState

+ func (t DockerOptionsTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t DockerOptionsTask) ExportSupport() ExportSupport

+ func (t DockerOptionsTask) MinimumVersions() VersionSupport

+ func (t DockerOptionsTask) Plan(ctx context.Context) PlanResult

+ func (t DockerOptionsTask) ProbeSupport() ProbeSupport

+ func (t DockerOptionsTask) Validate() error

+ type DockerOptionsTaskExample struct

+ DockerOptionsTask DockerOptionsTask

+ Name string

+ func (e DockerOptionsTaskExample) GetName() string

+ type Documented interface

+ Doc func() string

+ type DomainsTask struct

+ App string

+ Domains []string

+ Global bool

+ State State

+ func (t DomainsTask) Doc() string

+ func (t DomainsTask) Execute(ctx context.Context) TaskOutputState

+ func (t DomainsTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t DomainsTask) ExportSupport() ExportSupport

+ func (t DomainsTask) MinimumVersions() VersionSupport

+ func (t DomainsTask) Plan(ctx context.Context) PlanResult

+ func (t DomainsTask) ProbeSupport() ProbeSupport

+ func (t DomainsTask) Validate() error

+ type DomainsTaskExample struct

+ DomainsTask DomainsTask

+ Name string

+ func (e DomainsTaskExample) GetName() string

+ type DomainsToggleTask ToggleFields

+ func (t DomainsToggleTask) Doc() string

+ func (t DomainsToggleTask) Execute(ctx context.Context) TaskOutputState

+ func (t DomainsToggleTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t DomainsToggleTask) ExportSupport() ExportSupport

+ func (t DomainsToggleTask) MinimumVersions() VersionSupport

+ func (t DomainsToggleTask) Plan(ctx context.Context) PlanResult

+ func (t DomainsToggleTask) ProbeSupport() ProbeSupport

+ type DomainsToggleTaskExample struct

+ DomainsToggleTask DomainsToggleTask

+ Name string

+ func (e DomainsToggleTaskExample) GetName() string

+ type DynamicPropertySchema struct

+ Prefix string

+ Probeable bool

+ Scopes []string

+ Sensitive bool

+ func DynamicPropertyFamilies(plugin string) []DynamicPropertySchema

+ type ExampleSchema struct

+ Name string

+ YAML string

+ type ExportDocer interface

+ ExportSupport func() ExportSupport

+ type ExportOptions struct

+ Apps []string

+ Inline bool

+ Redact bool

+ Resources []ResourceSelector

+ type ExportReport struct

+ MissingApps []string

+ MissingResources []string

+ Warnings []string

+ type ExportResult struct

+ Report ExportReport

+ Vars map[string]string

+ func ExportRecipe(ctx context.Context, opts ExportOptions) (*ExportResult, error)

+ func (res *ExportResult) AppCount() int

+ func (res *ExportResult) HasVars() bool

+ func (res *ExportResult) MarshalRecipe(format string) ([]byte, error)

+ func (res *ExportResult) MarshalVars(format string) ([]byte, error)

+ func (res *ExportResult) PlayCount() int

+ func (res *ExportResult) Plays() []ExportedPlay

+ func (res *ExportResult) SensitiveValues() []string

+ type ExportStatus string

+ const ExportPartial

+ const ExportSupported

+ const ExportUnsupported

+ type ExportSupport struct

+ Caveat string

+ Status ExportStatus

+ func TaskExportSupport(t Task) (ExportSupport, bool)

+ type ExportedPlay struct

+ Inputs []map[string]interface{}

+ Name string

+ Tasks []ExportedTask

+ type ExportedTask struct

+ Body interface{}

+ Type string

+ func (t ExportedTask) MarshalYAML() (interface{}, error)

+ type FieldSchema struct

+ Choices []string

+ Default string

+ Description string

+ Identity string

+ Item *ItemSchema

+ Name string

+ Required bool

+ RunnerFile bool

+ Sensitive bool

+ Type string

+ type GitAuthTask struct

+ Host string

+ Password string

+ State State

+ Username string

+ func (t GitAuthTask) Doc() string

+ func (t GitAuthTask) Execute(ctx context.Context) TaskOutputState

+ func (t GitAuthTask) ExportSupport() ExportSupport

+ func (t GitAuthTask) MinimumVersions() VersionSupport

+ func (t GitAuthTask) Plan(ctx context.Context) PlanResult

+ func (t GitAuthTask) ProbeSupport() ProbeSupport

+ func (t GitAuthTask) Validate() error

+ type GitAuthTaskExample struct

+ GitAuthTask GitAuthTask

+ Name string

+ func (e GitAuthTaskExample) GetName() string

+ type GitFromArchiveTask struct

+ App string

+ ArchiveType string

+ ArchiveURL string

+ GitEmail string

+ GitUsername string

+ State State

+ func (t GitFromArchiveTask) Doc() string

+ func (t GitFromArchiveTask) Execute(ctx context.Context) TaskOutputState

+ func (t GitFromArchiveTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t GitFromArchiveTask) ExportSupport() ExportSupport

+ func (t GitFromArchiveTask) MinimumVersions() VersionSupport

+ func (t GitFromArchiveTask) Plan(ctx context.Context) PlanResult

+ func (t GitFromArchiveTask) ProbeSupport() ProbeSupport

+ func (t GitFromArchiveTask) Validate() error

+ type GitFromArchiveTaskExample struct

+ GitFromArchiveTask GitFromArchiveTask

+ Name string

+ func (e GitFromArchiveTaskExample) GetName() string

+ type GitFromImageTask struct

+ App string

+ BuildDir string

+ GitEmail string

+ GitUsername string

+ Image string

+ State State

+ func (t GitFromImageTask) Doc() string

+ func (t GitFromImageTask) Execute(ctx context.Context) TaskOutputState

+ func (t GitFromImageTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t GitFromImageTask) ExportSupport() ExportSupport

+ func (t GitFromImageTask) MinimumVersions() VersionSupport

+ func (t GitFromImageTask) Plan(ctx context.Context) PlanResult

+ func (t GitFromImageTask) ProbeSupport() ProbeSupport

+ func (t GitFromImageTask) Validate() error

+ type GitFromImageTaskExample struct

+ GitFromImageTask GitFromImageTask

+ Name string

+ func (e GitFromImageTaskExample) GetName() string

+ type GitPropertyTask PropertyFields

+ func (t GitPropertyTask) Doc() string

+ func (t GitPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t GitPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t GitPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t GitPropertyTask) ExportSupport() ExportSupport

+ func (t GitPropertyTask) MinimumVersions() VersionSupport

+ func (t GitPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t GitPropertyTask) ProbeSupport() ProbeSupport

+ func (t GitPropertyTask) Validate() error

+ type GitPropertyTaskExample struct

+ GitPropertyTask GitPropertyTask

+ Name string

+ func (e GitPropertyTaskExample) GetName() string

+ type GitSyncTask struct

+ App string

+ Build bool

+ BuildIfChanges bool

+ GitRef string

+ Remote string

+ SkipDeployBranch bool

+ State State

+ func (t GitSyncTask) Doc() string

+ func (t GitSyncTask) Execute(ctx context.Context) TaskOutputState

+ func (t GitSyncTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t GitSyncTask) ExportSupport() ExportSupport

+ func (t GitSyncTask) MinimumVersions() VersionSupport

+ func (t GitSyncTask) Plan(ctx context.Context) PlanResult

+ func (t GitSyncTask) ProbeSupport() ProbeSupport

+ type GitSyncTaskExample struct

+ GitSyncTask GitSyncTask

+ Name string

+ func (e GitSyncTaskExample) GetName() string

+ type GlobalExporter interface

+ ExportGlobal func(ctx context.Context) ([]interface{}, error)

+ type HaproxyPropertyTask PropertyFields

+ func (t HaproxyPropertyTask) Doc() string

+ func (t HaproxyPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t HaproxyPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t HaproxyPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t HaproxyPropertyTask) ExportSupport() ExportSupport

+ func (t HaproxyPropertyTask) MinimumVersions() VersionSupport

+ func (t HaproxyPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t HaproxyPropertyTask) ProbeSupport() ProbeSupport

+ func (t HaproxyPropertyTask) Validate() error

+ type HaproxyPropertyTaskExample struct

+ HaproxyPropertyTask HaproxyPropertyTask

+ Name string

+ func (e HaproxyPropertyTaskExample) GetName() string

+ type HttpAuthAllowedIpTask struct

+ AllowedIps []string

+ App string

+ State State

+ func (t HttpAuthAllowedIpTask) Doc() string

+ func (t HttpAuthAllowedIpTask) Execute(ctx context.Context) TaskOutputState

+ func (t HttpAuthAllowedIpTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t HttpAuthAllowedIpTask) ExportSupport() ExportSupport

+ func (t HttpAuthAllowedIpTask) MinimumVersions() VersionSupport

+ func (t HttpAuthAllowedIpTask) Plan(ctx context.Context) PlanResult

+ func (t HttpAuthAllowedIpTask) ProbeSupport() ProbeSupport

+ func (t HttpAuthAllowedIpTask) Validate() error

+ type HttpAuthAllowedIpTaskExample struct

+ DokkuHttpAuthAllowedIp HttpAuthAllowedIpTask

+ Name string

+ func (e HttpAuthAllowedIpTaskExample) GetName() string

+ type HttpAuthDomainTask struct

+ App string

+ Domains []string

+ State State

+ func (t HttpAuthDomainTask) Doc() string

+ func (t HttpAuthDomainTask) Execute(ctx context.Context) TaskOutputState

+ func (t HttpAuthDomainTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t HttpAuthDomainTask) ExportSupport() ExportSupport

+ func (t HttpAuthDomainTask) MinimumVersions() VersionSupport

+ func (t HttpAuthDomainTask) Plan(ctx context.Context) PlanResult

+ func (t HttpAuthDomainTask) ProbeSupport() ProbeSupport

+ func (t HttpAuthDomainTask) Validate() error

+ type HttpAuthDomainTaskExample struct

+ DokkuHttpAuthDomain HttpAuthDomainTask

+ Name string

+ func (e HttpAuthDomainTaskExample) GetName() string

+ type HttpAuthTask struct

+ App string

+ Password string

+ State State

+ Username string

+ func (t HttpAuthTask) Doc() string

+ func (t HttpAuthTask) Execute(ctx context.Context) TaskOutputState

+ func (t HttpAuthTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t HttpAuthTask) ExportSupport() ExportSupport

+ func (t HttpAuthTask) MinimumVersions() VersionSupport

+ func (t HttpAuthTask) Plan(ctx context.Context) PlanResult

+ func (t HttpAuthTask) ProbeSupport() ProbeSupport

+ func (t HttpAuthTask) Validate() error

+ type HttpAuthTaskExample struct

+ DokkuHttpAuth HttpAuthTask

+ Name string

+ func (e HttpAuthTaskExample) GetName() string

+ type HttpAuthUser struct

+ Hash string

+ Password string

+ Username string

+ type HttpAuthUserTask struct

+ App string

+ State State

+ UpdatePassword *bool

+ Users []HttpAuthUser

+ func (t HttpAuthUserTask) Doc() string

+ func (t HttpAuthUserTask) Execute(ctx context.Context) TaskOutputState

+ func (t HttpAuthUserTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t HttpAuthUserTask) ExportSupport() ExportSupport

+ func (t HttpAuthUserTask) MinimumVersions() VersionSupport

+ func (t HttpAuthUserTask) Plan(ctx context.Context) PlanResult

+ func (t HttpAuthUserTask) ProbeSupport() ProbeSupport

+ func (t HttpAuthUserTask) SensitiveValues() []string

+ func (t HttpAuthUserTask) Validate() error

+ type HttpAuthUserTaskExample struct

+ DokkuHttpAuthUser HttpAuthUserTask

+ Name string

+ func (e HttpAuthUserTaskExample) GetName() string

+ type IdentityCollection struct

+ Field string

+ Item ItemIdentity

+ ItemKeys []string

+ YAMLName string

+ func TaskIdentityCollections(t Task) []IdentityCollection

+ type IdentityCollectionSchema struct

+ Item ItemIdentity

+ ItemKeys []string

+ Name string

+ type IdentityKey struct

+ Field string

+ Present bool

+ Value string

+ YAMLName string

+ func TaskIdentity(t Task) []IdentityKey

+ type IdentitySchema struct

+ Collections []IdentityCollectionSchema

+ Keys []string

+ type Input struct

+ Default string

+ Description string

+ Name string

+ Required bool

+ Sensitive bool

+ Type string

+ func (i *Input) SetValue(value string) error

+ func (i Input) GetValue() string

+ func (i Input) HasValue() bool

+ type InputValidator interface

+ Validate func() error

+ type ItemIdentity string

+ const ItemIdentityFields

+ const ItemIdentityMapKey

+ const ItemIdentityValue

+ type ItemSchema struct

+ Fields []FieldSchema

+ Identity ItemIdentity

+ KeyType string

+ Keys []string

+ Type string

+ type LetsencryptPropertyTask SensitivePropertyFields

+ func (t LetsencryptPropertyTask) Doc() string

+ func (t LetsencryptPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t LetsencryptPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t LetsencryptPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t LetsencryptPropertyTask) ExportSupport() ExportSupport

+ func (t LetsencryptPropertyTask) MinimumVersions() VersionSupport

+ func (t LetsencryptPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t LetsencryptPropertyTask) ProbeSupport() ProbeSupport

+ func (t LetsencryptPropertyTask) Validate() error

+ type LetsencryptPropertyTaskExample struct

+ LetsencryptPropertyTask LetsencryptPropertyTask

+ Name string

+ func (e LetsencryptPropertyTaskExample) GetName() string

+ type LetsencryptTask struct

+ App string

+ State State

+ func (t LetsencryptTask) Doc() string

+ func (t LetsencryptTask) Execute(ctx context.Context) TaskOutputState

+ func (t LetsencryptTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t LetsencryptTask) ExportSupport() ExportSupport

+ func (t LetsencryptTask) MinimumVersions() VersionSupport

+ func (t LetsencryptTask) Plan(ctx context.Context) PlanResult

+ func (t LetsencryptTask) ProbeSupport() ProbeSupport

+ func (t LetsencryptTask) Validate() error

+ type LetsencryptTaskExample struct

+ LetsencryptTask LetsencryptTask

+ Name string

+ func (e LetsencryptTaskExample) GetName() string

+ type LogsPropertyTask PropertyFields

+ func (t LogsPropertyTask) Doc() string

+ func (t LogsPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t LogsPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t LogsPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t LogsPropertyTask) ExportSupport() ExportSupport

+ func (t LogsPropertyTask) MinimumVersions() VersionSupport

+ func (t LogsPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t LogsPropertyTask) ProbeSupport() ProbeSupport

+ func (t LogsPropertyTask) Validate() error

+ type LogsPropertyTaskExample struct

+ LogsPropertyTask LogsPropertyTask

+ Name string

+ func (e LogsPropertyTaskExample) GetName() string

+ type MaintenanceCustomPageTask struct

+ App string

+ Content string

+ State State

+ Tarball string

+ func (t MaintenanceCustomPageTask) Doc() string

+ func (t MaintenanceCustomPageTask) Execute(ctx context.Context) TaskOutputState

+ func (t MaintenanceCustomPageTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t MaintenanceCustomPageTask) ExportAppReport(ctx context.Context, app string, warn func(msg string)) ([]interface{}, error)

+ func (t MaintenanceCustomPageTask) ExportSupport() ExportSupport

+ func (t MaintenanceCustomPageTask) MinimumVersions() VersionSupport

+ func (t MaintenanceCustomPageTask) Plan(ctx context.Context) PlanResult

+ func (t MaintenanceCustomPageTask) ProbeSupport() ProbeSupport

+ func (t MaintenanceCustomPageTask) Validate() error

+ type MaintenanceCustomPageTaskExample struct

+ MaintenanceCustomPageTask MaintenanceCustomPageTask

+ Name string

+ func (e MaintenanceCustomPageTaskExample) GetName() string

+ type MaintenanceTask ToggleFields

+ func (t MaintenanceTask) Doc() string

+ func (t MaintenanceTask) Execute(ctx context.Context) TaskOutputState

+ func (t MaintenanceTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t MaintenanceTask) ExportSupport() ExportSupport

+ func (t MaintenanceTask) MinimumVersions() VersionSupport

+ func (t MaintenanceTask) Plan(ctx context.Context) PlanResult

+ func (t MaintenanceTask) ProbeSupport() ProbeSupport

+ type MaintenanceTaskExample struct

+ MaintenanceTask MaintenanceTask

+ Name string

+ func (e MaintenanceTaskExample) GetName() string

+ type NetworkPropertyTask PropertyFields

+ func (t NetworkPropertyTask) Doc() string

+ func (t NetworkPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t NetworkPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t NetworkPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t NetworkPropertyTask) ExportSupport() ExportSupport

+ func (t NetworkPropertyTask) MinimumVersions() VersionSupport

+ func (t NetworkPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t NetworkPropertyTask) ProbeSupport() ProbeSupport

+ func (t NetworkPropertyTask) Validate() error

+ type NetworkPropertyTaskExample struct

+ Name string

+ NetworkPropertyTask NetworkPropertyTask

+ func (e NetworkPropertyTaskExample) GetName() string

+ type NetworkTask struct

+ Name string

+ State State

+ func (t NetworkTask) Doc() string

+ func (t NetworkTask) Execute(ctx context.Context) TaskOutputState

+ func (t NetworkTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t NetworkTask) ExportSupport() ExportSupport

+ func (t NetworkTask) MinimumVersions() VersionSupport

+ func (t NetworkTask) Plan(ctx context.Context) PlanResult

+ func (t NetworkTask) ProbeSupport() ProbeSupport

+ type NetworkTaskExample struct

+ DokkuNetwork NetworkTask

+ Name string

+ func (e NetworkTaskExample) GetName() string

+ type NginxPropertyTask PropertyFields

+ func (t NginxPropertyTask) Doc() string

+ func (t NginxPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t NginxPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t NginxPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t NginxPropertyTask) ExportSupport() ExportSupport

+ func (t NginxPropertyTask) MinimumVersions() VersionSupport

+ func (t NginxPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t NginxPropertyTask) ProbeSupport() ProbeSupport

+ func (t NginxPropertyTask) Validate() error

+ type NginxPropertyTaskExample struct

+ Name string

+ NginxPropertyTask NginxPropertyTask

+ func (e NginxPropertyTaskExample) GetName() string

+ type OpenrestyPropertyTask PropertyFields

+ func (t OpenrestyPropertyTask) Doc() string

+ func (t OpenrestyPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t OpenrestyPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t OpenrestyPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t OpenrestyPropertyTask) ExportSupport() ExportSupport

+ func (t OpenrestyPropertyTask) MinimumVersions() VersionSupport

+ func (t OpenrestyPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t OpenrestyPropertyTask) ProbeSupport() ProbeSupport

+ func (t OpenrestyPropertyTask) Validate() error

+ type OpenrestyPropertyTaskExample struct

+ Name string

+ OpenrestyPropertyTask OpenrestyPropertyTask

+ func (e OpenrestyPropertyTaskExample) GetName() string

+ type OrderedStringEnvelopeMap struct

+ func GetTasks(data []byte, context map[string]interface{}) (OrderedStringEnvelopeMap, error)

+ func (o *OrderedStringEnvelopeMap) Get(k string) Task

+ func (o *OrderedStringEnvelopeMap) GetEnvelope(k string) *TaskEnvelope

+ func (o *OrderedStringEnvelopeMap) Keys() []string

+ func (o *OrderedStringEnvelopeMap) Set(k string, env *TaskEnvelope)

+ type PlanResult struct

+ Commands []string

+ DesiredState State

+ Error error

+ ExitCode int

+ InSync bool

+ Mutations []string

+ Reason string

+ Status PlanStatus

+ Stderr string

+ Stdout string

+ Warnings []PlanWarning

+ func DispatchPlan(state State, funcMap map[State]func() PlanResult) PlanResult

+ func PlanErrorFromExec(desiredState State, err error, r subprocess.ExecCommandResponse) PlanResult

+ type PlanStatus string

+ const PlanStatusCreate

+ const PlanStatusDestroy

+ const PlanStatusError

+ const PlanStatusModify

+ const PlanStatusOK

+ type PlanWarning struct

+ Message string

+ Reason string

+ type Play struct

+ AcceptNewHostKeys *bool

+ Host string

+ Inputs []Input

+ Name string

+ Sudo *bool

+ Tags []string

+ Tasks OrderedStringEnvelopeMap

+ When string

+ func GetPlays(data []byte, context map[string]interface{}, userSet map[string]bool) ([]*Play, error)

+ func GetPlaysWithFormat(data []byte, format string, context map[string]interface{}, ...) ([]*Play, error)

+ func (p *Play) HasWhen() bool

+ func (p *Play) IsFileLevel() bool

+ func (p *Play) ResolveTarget(base subprocess.Target) subprocess.Target

+ func (p *Play) WhenProgram() *vm.Program

+ type PluginRequirement struct

+ Minimum string

+ Name string

+ NameField string

+ Text string

+ WhenField string

+ type PluginRequirementSchema struct

+ Minimum string

+ Name string

+ NameField string

+ When string

+ type PluginTask struct

+ Committish string

+ Name string

+ State State

+ URL string

+ func (t PluginTask) Doc() string

+ func (t PluginTask) Execute(ctx context.Context) TaskOutputState

+ func (t PluginTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t PluginTask) ExportSupport() ExportSupport

+ func (t PluginTask) MinimumVersions() VersionSupport

+ func (t PluginTask) Plan(ctx context.Context) PlanResult

+ func (t PluginTask) ProbeSupport() ProbeSupport

+ func (t PluginTask) Validate() error

+ type PluginTaskExample struct

+ Name string

+ PluginTask PluginTask

+ func (e PluginTaskExample) GetName() string

+ type PortMapping struct

+ Container int

+ Host int

+ Scheme string

+ func (p PortMapping) String() string

+ type PortsTask struct

+ App string

+ PortMappings []PortMapping

+ State State

+ func (t PortsTask) Doc() string

+ func (t PortsTask) Execute(ctx context.Context) TaskOutputState

+ func (t PortsTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t PortsTask) ExportSupport() ExportSupport

+ func (t PortsTask) MinimumVersions() VersionSupport

+ func (t PortsTask) Plan(ctx context.Context) PlanResult

+ func (t PortsTask) ProbeSupport() ProbeSupport

+ func (t PortsTask) Validate() error

+ type PortsTaskExample struct

+ Name string

+ PortsTask PortsTask

+ func (e PortsTaskExample) GetName() string

+ type ProbeDocer interface

+ ProbeSupport func() ProbeSupport

+ type ProbeStatus string

+ const ProbePartial

+ const ProbeSupported

+ const ProbeUnsupported

+ type ProbeSupport struct

+ Caveat string

+ Status ProbeStatus

+ func TaskProbeSupport(t Task) (ProbeSupport, bool)

+ type Problem struct

+ Code string

+ Column int

+ Hint string

+ Line int

+ Message string

+ Play string

+ Task string

+ func Validate(data []byte, opts ValidateOptions) []Problem

+ type PropertyEntrySchema struct

+ AppReportKey string

+ GlobalReportKey string

+ Name string

+ Scopes []string

+ Sensitive bool

+ type PropertyFields struct

+ App string

+ Global bool

+ Property string

+ State State

+ Value string

+ type PropertyKeys struct

+ Global string

+ PerApp string

+ Sensitive bool

+ type PropertySchema struct

+ Dynamic []DynamicPropertySchema

+ Field string

+ Plugin string

+ Properties []PropertyEntrySchema

+ Rejected []RejectedPropertySchema

+ Subcommand string

+ type PropertyTable struct

+ Keys map[string]PropertyKeys

+ Rejected []RejectedPropertyFamily

+ Subcommand string

+ func TaskPropertyTable(t Task) (PropertyTable, bool)

+ func (p PropertyTable) Plugin() string

+ type PropertyTableDocer interface

+ type ProxyPropertyTask PropertyFields

+ func (t ProxyPropertyTask) Doc() string

+ func (t ProxyPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t ProxyPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ProxyPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t ProxyPropertyTask) ExportSupport() ExportSupport

+ func (t ProxyPropertyTask) MinimumVersions() VersionSupport

+ func (t ProxyPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t ProxyPropertyTask) ProbeSupport() ProbeSupport

+ func (t ProxyPropertyTask) Validate() error

+ type ProxyPropertyTaskExample struct

+ Name string

+ ProxyPropertyTask ProxyPropertyTask

+ func (e ProxyPropertyTaskExample) GetName() string

+ type ProxyToggleTask ToggleFields

+ func (t ProxyToggleTask) Doc() string

+ func (t ProxyToggleTask) Execute(ctx context.Context) TaskOutputState

+ func (t ProxyToggleTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ProxyToggleTask) ExportSupport() ExportSupport

+ func (t ProxyToggleTask) MinimumVersions() VersionSupport

+ func (t ProxyToggleTask) Plan(ctx context.Context) PlanResult

+ func (t ProxyToggleTask) ProbeSupport() ProbeSupport

+ type ProxyToggleTaskExample struct

+ Name string

+ ProxyToggleTask ProxyToggleTask

+ func (e ProxyToggleTaskExample) GetName() string

+ type PsPropertyTask PropertyFields

+ func (t PsPropertyTask) Doc() string

+ func (t PsPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t PsPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t PsPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t PsPropertyTask) ExportSupport() ExportSupport

+ func (t PsPropertyTask) MinimumVersions() VersionSupport

+ func (t PsPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t PsPropertyTask) ProbeSupport() ProbeSupport

+ func (t PsPropertyTask) Validate() error

+ type PsPropertyTaskExample struct

+ Name string

+ PsPropertyTask PsPropertyTask

+ func (e PsPropertyTaskExample) GetName() string

+ type PsScaleTask struct

+ App string

+ Scale map[string]int

+ SkipDeploy *bool

+ State State

+ func (t PsScaleTask) Doc() string

+ func (t PsScaleTask) Execute(ctx context.Context) TaskOutputState

+ func (t PsScaleTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t PsScaleTask) ExportSupport() ExportSupport

+ func (t PsScaleTask) MinimumVersions() VersionSupport

+ func (t PsScaleTask) Plan(ctx context.Context) PlanResult

+ func (t PsScaleTask) ProbeSupport() ProbeSupport

+ func (t PsScaleTask) Validate() error

+ type PsScaleTaskExample struct

+ Name string

+ PsScaleTask PsScaleTask

+ func (e PsScaleTaskExample) GetName() string

+ type Recipe []RecipeEntry

+ func UnmarshalRecipe(data []byte, format string) (Recipe, error)

+ type RecipeEntry struct

+ AcceptNewHostKeys *bool

+ Host string

+ Inputs []Input

+ Name string

+ Sudo *bool

+ Tags interface{}

+ Tasks []map[string]interface{}

+ When string

+ type RegisteredValue struct

+ Results []TaskOutputState

+ func AggregateRegistered(iter []TaskOutputState) RegisteredValue

+ type RegistryAuthTask struct

+ App string

+ Global bool

+ Password string

+ Server string

+ State State

+ Username string

+ func (t RegistryAuthTask) Doc() string

+ func (t RegistryAuthTask) Execute(ctx context.Context) TaskOutputState

+ func (t RegistryAuthTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t RegistryAuthTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t RegistryAuthTask) ExportSupport() ExportSupport

+ func (t RegistryAuthTask) MinimumVersions() VersionSupport

+ func (t RegistryAuthTask) Plan(ctx context.Context) PlanResult

+ func (t RegistryAuthTask) ProbeSupport() ProbeSupport

+ func (t RegistryAuthTask) Validate() error

+ type RegistryAuthTaskExample struct

+ Name string

+ RegistryAuthTask RegistryAuthTask

+ func (e RegistryAuthTaskExample) GetName() string

+ type RegistryPropertyTask PropertyFields

+ func (t RegistryPropertyTask) Doc() string

+ func (t RegistryPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t RegistryPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t RegistryPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t RegistryPropertyTask) ExportSupport() ExportSupport

+ func (t RegistryPropertyTask) MinimumVersions() VersionSupport

+ func (t RegistryPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t RegistryPropertyTask) ProbeSupport() ProbeSupport

+ func (t RegistryPropertyTask) Validate() error

+ type RegistryPropertyTaskExample struct

+ Name string

+ RegistryPropertyTask RegistryPropertyTask

+ func (e RegistryPropertyTaskExample) GetName() string

+ type RejectedPropertyFamily struct

+ Prefix string

+ Reason string

+ Replacement string

+ type RejectedPropertySchema struct

+ Prefix string

+ Reason string

+ Replacement string

+ func RejectedPropertyFamilies(table PropertyTable) []RejectedPropertySchema

+ type ResourceContext struct

+ App string

+ ClearBefore bool

+ ProcessType string

+ Resources map[string]string

+ type ResourceLimitTask struct

+ App string

+ ClearBefore *bool

+ ProcessType string

+ Resources map[string]string

+ State State

+ func (t ResourceLimitTask) Doc() string

+ func (t ResourceLimitTask) Execute(ctx context.Context) TaskOutputState

+ func (t ResourceLimitTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ResourceLimitTask) ExportSupport() ExportSupport

+ func (t ResourceLimitTask) MinimumVersions() VersionSupport

+ func (t ResourceLimitTask) Plan(ctx context.Context) PlanResult

+ func (t ResourceLimitTask) ProbeSupport() ProbeSupport

+ func (t ResourceLimitTask) Validate() error

+ type ResourceLimitTaskExample struct

+ Name string

+ ResourceLimitTask ResourceLimitTask

+ func (e ResourceLimitTaskExample) GetName() string

+ type ResourceReserveTask struct

+ App string

+ ClearBefore *bool

+ ProcessType string

+ Resources map[string]string

+ State State

+ func (t ResourceReserveTask) Doc() string

+ func (t ResourceReserveTask) Execute(ctx context.Context) TaskOutputState

+ func (t ResourceReserveTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ResourceReserveTask) ExportSupport() ExportSupport

+ func (t ResourceReserveTask) MinimumVersions() VersionSupport

+ func (t ResourceReserveTask) Plan(ctx context.Context) PlanResult

+ func (t ResourceReserveTask) ProbeSupport() ProbeSupport

+ func (t ResourceReserveTask) Validate() error

+ type ResourceReserveTaskExample struct

+ Name string

+ ResourceReserveTask ResourceReserveTask

+ func (e ResourceReserveTaskExample) GetName() string

+ type ResourceSelector struct

+ Address string

+ Keys map[string]string

+ TypeKey string

+ func ParseResourceSelectors(addresses []string) ([]ResourceSelector, error)

+ type SchedulerDockerLocalPropertyTask PropertyFields

+ func (t SchedulerDockerLocalPropertyTask) Doc() string

+ func (t SchedulerDockerLocalPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerDockerLocalPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t SchedulerDockerLocalPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerDockerLocalPropertyTask) ExportSupport() ExportSupport

+ func (t SchedulerDockerLocalPropertyTask) MinimumVersions() VersionSupport

+ func (t SchedulerDockerLocalPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerDockerLocalPropertyTask) ProbeSupport() ProbeSupport

+ func (t SchedulerDockerLocalPropertyTask) Validate() error

+ type SchedulerDockerLocalPropertyTaskExample struct

+ Name string

+ SchedulerDockerLocalPropertyTask SchedulerDockerLocalPropertyTask

+ func (e SchedulerDockerLocalPropertyTaskExample) GetName() string

+ type SchedulerK3sAnnotationsTask struct

+ Annotations map[string]string

+ App string

+ Global bool

+ ProcessType string

+ ResourceType string

+ State State

+ func (t SchedulerK3sAnnotationsTask) Doc() string

+ func (t SchedulerK3sAnnotationsTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sAnnotationsTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t SchedulerK3sAnnotationsTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sAnnotationsTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sAnnotationsTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sAnnotationsTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sAnnotationsTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sAnnotationsTask) Validate() error

+ type SchedulerK3sAnnotationsTaskExample struct

+ Name string

+ SchedulerK3sAnnotationsTask SchedulerK3sAnnotationsTask

+ func (e SchedulerK3sAnnotationsTaskExample) GetName() string

+ type SchedulerK3sAutoscalingAuthTask struct

+ App string

+ Global bool

+ Metadata map[string]string

+ State State

+ Trigger string

+ func (t SchedulerK3sAutoscalingAuthTask) Doc() string

+ func (t SchedulerK3sAutoscalingAuthTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sAutoscalingAuthTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t SchedulerK3sAutoscalingAuthTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sAutoscalingAuthTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sAutoscalingAuthTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sAutoscalingAuthTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sAutoscalingAuthTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sAutoscalingAuthTask) SensitiveValues() []string

+ func (t SchedulerK3sAutoscalingAuthTask) Validate() error

+ type SchedulerK3sAutoscalingAuthTaskExample struct

+ Name string

+ SchedulerK3sAutoscalingAuthTask SchedulerK3sAutoscalingAuthTask

+ func (e SchedulerK3sAutoscalingAuthTaskExample) GetName() string

+ type SchedulerK3sChartTask struct

+ Chart string

+ State State

+ Values map[string]any

+ func (t SchedulerK3sChartTask) Doc() string

+ func (t SchedulerK3sChartTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sChartTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sChartTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sChartTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sChartTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sChartTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sChartTask) Validate() error

+ type SchedulerK3sChartTaskExample struct

+ Name string

+ SchedulerK3sChartTask SchedulerK3sChartTask

+ func (e SchedulerK3sChartTaskExample) GetName() string

+ type SchedulerK3sLabelsTask struct

+ App string

+ Global bool

+ Labels map[string]string

+ ProcessType string

+ ResourceType string

+ State State

+ func (t SchedulerK3sLabelsTask) Doc() string

+ func (t SchedulerK3sLabelsTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sLabelsTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t SchedulerK3sLabelsTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sLabelsTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sLabelsTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sLabelsTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sLabelsTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sLabelsTask) Validate() error

+ type SchedulerK3sLabelsTaskExample struct

+ Name string

+ SchedulerK3sLabelsTask SchedulerK3sLabelsTask

+ func (e SchedulerK3sLabelsTaskExample) GetName() string

+ type SchedulerK3sNodeSysctlsTask struct

+ Global bool

+ Profile string

+ State State

+ Sysctls map[string]string

+ func (t SchedulerK3sNodeSysctlsTask) Doc() string

+ func (t SchedulerK3sNodeSysctlsTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sNodeSysctlsTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sNodeSysctlsTask) ExportGlobalReport(ctx context.Context, warn func(msg string)) ([]interface{}, error)

+ func (t SchedulerK3sNodeSysctlsTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sNodeSysctlsTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sNodeSysctlsTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sNodeSysctlsTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sNodeSysctlsTask) Validate() error

+ type SchedulerK3sNodeSysctlsTaskExample struct

+ Name string

+ SchedulerK3sNodeSysctlsTask SchedulerK3sNodeSysctlsTask

+ func (e SchedulerK3sNodeSysctlsTaskExample) GetName() string

+ type SchedulerK3sProfileTask struct

+ AllowUnknownHosts bool

+ KubeletArgs []string

+ Name string

+ Role string

+ State State

+ TaintScheduling bool

+ func (t SchedulerK3sProfileTask) Doc() string

+ func (t SchedulerK3sProfileTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sProfileTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sProfileTask) ExportGlobalReport(ctx context.Context, warn func(msg string)) ([]interface{}, error)

+ func (t SchedulerK3sProfileTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sProfileTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sProfileTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sProfileTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sProfileTask) Validate() error

+ type SchedulerK3sProfileTaskExample struct

+ Name string

+ SchedulerK3sProfileTask SchedulerK3sProfileTask

+ func (e SchedulerK3sProfileTaskExample) GetName() string

+ type SchedulerK3sPropertyTask PropertyFields

+ func (t SchedulerK3sPropertyTask) Doc() string

+ func (t SchedulerK3sPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerK3sPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t SchedulerK3sPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerK3sPropertyTask) ExportSupport() ExportSupport

+ func (t SchedulerK3sPropertyTask) MinimumVersions() VersionSupport

+ func (t SchedulerK3sPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerK3sPropertyTask) ProbeSupport() ProbeSupport

+ func (t SchedulerK3sPropertyTask) Validate() error

+ type SchedulerK3sPropertyTaskExample struct

+ Name string

+ SchedulerK3sPropertyTask SchedulerK3sPropertyTask

+ func (e SchedulerK3sPropertyTaskExample) GetName() string

+ type SchedulerPropertyTask PropertyFields

+ func (t SchedulerPropertyTask) Doc() string

+ func (t SchedulerPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t SchedulerPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t SchedulerPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SchedulerPropertyTask) ExportSupport() ExportSupport

+ func (t SchedulerPropertyTask) MinimumVersions() VersionSupport

+ func (t SchedulerPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t SchedulerPropertyTask) ProbeSupport() ProbeSupport

+ func (t SchedulerPropertyTask) Validate() error

+ type SchedulerPropertyTaskExample struct

+ Name string

+ SchedulerPropertyTask SchedulerPropertyTask

+ func (e SchedulerPropertyTaskExample) GetName() string

+ type SensitiveOverride interface

+ SensitiveValues func() []string

+ type SensitivePropertyFields struct

+ App string

+ Global bool

+ Property string

+ State State

+ Value string

+ type ServiceBackupTask struct

+ AwsAccessKeyID string

+ AwsDefaultRegion string

+ AwsSecretAccessKey string

+ AwsSignatureVersion string

+ Bucket string

+ EncryptionPassphrase string

+ EndpointURL string

+ Name string

+ Schedule string

+ Service string

+ State State

+ UseIam bool

+ func (t ServiceBackupTask) Doc() string

+ func (t ServiceBackupTask) Execute(ctx context.Context) TaskOutputState

+ func (t ServiceBackupTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t ServiceBackupTask) ExportSupport() ExportSupport

+ func (t ServiceBackupTask) MinimumVersions() VersionSupport

+ func (t ServiceBackupTask) Plan(ctx context.Context) PlanResult

+ func (t ServiceBackupTask) ProbeSupport() ProbeSupport

+ func (t ServiceBackupTask) Validate() error

+ type ServiceBackupTaskExample struct

+ Name string

+ ServiceBackupTask ServiceBackupTask

+ func (e ServiceBackupTaskExample) GetName() string

+ type ServiceCreateTask struct

+ ConfigOptions string

+ CustomEnv map[string]string

+ Image string

+ ImageDrift string

+ ImageVersion string

+ InitialNetwork string

+ Memory int

+ Name string

+ Password string

+ PostCreateNetwork []string

+ PostStartNetwork []string

+ RestartApps bool

+ RootPassword string

+ Service string

+ ShmSize string

+ State State

+ func (t ServiceCreateTask) Doc() string

+ func (t ServiceCreateTask) Execute(ctx context.Context) TaskOutputState

+ func (t ServiceCreateTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t ServiceCreateTask) ExportSupport() ExportSupport

+ func (t ServiceCreateTask) MinimumVersions() VersionSupport

+ func (t ServiceCreateTask) Plan(ctx context.Context) PlanResult

+ func (t ServiceCreateTask) ProbeSupport() ProbeSupport

+ func (t ServiceCreateTask) Validate() error

+ type ServiceCreateTaskExample struct

+ Name string

+ ServiceCreateTask ServiceCreateTask

+ func (e ServiceCreateTaskExample) GetName() string

+ type ServiceExposeTask struct

+ Name string

+ Ports []string

+ Service string

+ State State

+ func (t ServiceExposeTask) Doc() string

+ func (t ServiceExposeTask) Execute(ctx context.Context) TaskOutputState

+ func (t ServiceExposeTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t ServiceExposeTask) ExportSupport() ExportSupport

+ func (t ServiceExposeTask) MinimumVersions() VersionSupport

+ func (t ServiceExposeTask) Plan(ctx context.Context) PlanResult

+ func (t ServiceExposeTask) ProbeSupport() ProbeSupport

+ func (t ServiceExposeTask) Validate() error

+ type ServiceExposeTaskExample struct

+ Name string

+ ServiceExposeTask ServiceExposeTask

+ func (e ServiceExposeTaskExample) GetName() string

+ type ServiceLinkTask struct

+ App string

+ Name string

+ Service string

+ State State

+ func (t ServiceLinkTask) Doc() string

+ func (t ServiceLinkTask) Execute(ctx context.Context) TaskOutputState

+ func (t ServiceLinkTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t ServiceLinkTask) ExportSupport() ExportSupport

+ func (t ServiceLinkTask) MinimumVersions() VersionSupport

+ func (t ServiceLinkTask) Plan(ctx context.Context) PlanResult

+ func (t ServiceLinkTask) ProbeSupport() ProbeSupport

+ type ServiceLinkTaskExample struct

+ Name string

+ ServiceLinkTask ServiceLinkTask

+ func (e ServiceLinkTaskExample) GetName() string

+ type ServicePropertyTask struct

+ Name string

+ Property string

+ Service string

+ State State

+ Value string

+ func (t ServicePropertyTask) Doc() string

+ func (t ServicePropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t ServicePropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t ServicePropertyTask) ExportSupport() ExportSupport

+ func (t ServicePropertyTask) MinimumVersions() VersionSupport

+ func (t ServicePropertyTask) Plan(ctx context.Context) PlanResult

+ func (t ServicePropertyTask) ProbeSupport() ProbeSupport

+ func (t ServicePropertyTask) SensitiveValues() []string

+ func (t ServicePropertyTask) Validate() error

+ type ServicePropertyTaskExample struct

+ Name string

+ ServicePropertyTask ServicePropertyTask

+ func (e ServicePropertyTaskExample) GetName() string

+ type SshKeyTask struct

+ Key string

+ Name string

+ State State

+ func (t SshKeyTask) Doc() string

+ func (t SshKeyTask) Execute(ctx context.Context) TaskOutputState

+ func (t SshKeyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t SshKeyTask) ExportSupport() ExportSupport

+ func (t SshKeyTask) MinimumVersions() VersionSupport

+ func (t SshKeyTask) Plan(ctx context.Context) PlanResult

+ func (t SshKeyTask) ProbeSupport() ProbeSupport

+ func (t SshKeyTask) Validate() error

+ type SshKeyTaskExample struct

+ Name string

+ SshKeyTask SshKeyTask

+ func (e SshKeyTaskExample) GetName() string

+ type State string

+ const StateAbsent

+ const StateClear

+ const StateDeployed

+ const StatePresent

+ const StateSet

+ const StateSkipped

+ type StorageEnsureTask struct

+ App string

+ Chown string

+ State State

+ func (t StorageEnsureTask) Deprecation() string

+ func (t StorageEnsureTask) Doc() string

+ func (t StorageEnsureTask) Execute(ctx context.Context) TaskOutputState

+ func (t StorageEnsureTask) ExportSupport() ExportSupport

+ func (t StorageEnsureTask) MinimumVersions() VersionSupport

+ func (t StorageEnsureTask) Plan(ctx context.Context) PlanResult

+ func (t StorageEnsureTask) ProbeSupport() ProbeSupport

+ func (t StorageEnsureTask) Validate() error

+ type StorageEnsureTaskExample struct

+ Name string

+ StorageEnsureTask StorageEnsureTask

+ func (e StorageEnsureTaskExample) GetName() string

+ type StorageEntryTask struct

+ AccessMode string

+ Annotations map[string]string

+ Chown string

+ DestroyHostDir bool

+ Labels map[string]string

+ Mode string

+ Name string

+ Namespace string

+ Path string

+ ReclaimPolicy string

+ Scheduler string

+ Size string

+ State State

+ StorageClass string

+ func (t StorageEntryTask) Doc() string

+ func (t StorageEntryTask) Execute(ctx context.Context) TaskOutputState

+ func (t StorageEntryTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t StorageEntryTask) ExportSupport() ExportSupport

+ func (t StorageEntryTask) MinimumVersions() VersionSupport

+ func (t StorageEntryTask) Plan(ctx context.Context) PlanResult

+ func (t StorageEntryTask) ProbeSupport() ProbeSupport

+ func (t StorageEntryTask) Validate() error

+ type StorageEntryTaskExample struct

+ Name string

+ StorageEntryTask StorageEntryTask

+ func (e StorageEntryTaskExample) GetName() string

+ type StorageMount struct

+ ContainerDir string

+ EntryName string

+ HostDir string

+ Phases []string

+ Readonly bool

+ Subpath string

+ VolumeChown string

+ VolumeOptions string

+ type StorageMountTask struct

+ App string

+ ContainerDir string

+ EntryName string

+ HostDir string

+ Mounts []StorageMount

+ Phases []string

+ ProcessType string

+ Readonly bool

+ State State

+ Subpath string

+ VolumeChown string

+ VolumeOptions string

+ func (t StorageMountTask) Doc() string

+ func (t StorageMountTask) Execute(ctx context.Context) TaskOutputState

+ func (t StorageMountTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t StorageMountTask) ExportSupport() ExportSupport

+ func (t StorageMountTask) MinimumVersions() VersionSupport

+ func (t StorageMountTask) Plan(ctx context.Context) PlanResult

+ func (t StorageMountTask) ProbeSupport() ProbeSupport

+ func (t StorageMountTask) Validate() error

+ type StorageMountTaskExample struct

+ Name string

+ StorageMountTask StorageMountTask

+ func (e StorageMountTaskExample) GetName() string

+ type Task interface

+ Execute func(ctx context.Context) TaskOutputState

+ Plan func(ctx context.Context) PlanResult

+ func DecodeTask(typeKey string, body []byte) (Task, error)

+ func Lookup(typeKey string) (Task, bool)

+ func NewTask(typeKey string) (Task, error)

+ type TaskCatalog struct

+ Tasks []TaskSchema

+ Version int

+ func Catalog() (TaskCatalog, error)

+ func CatalogFor(typeKeys []string) (TaskCatalog, error)

+ func (c TaskCatalog) Encode(w io.Writer) error

+ type TaskEnvelope struct

+ Always []*TaskEnvelope

+ Block []*TaskEnvelope

+ ChangedWhen string

+ FailedWhen string

+ IgnoreErrors bool

+ IsLoopExpansion bool

+ Loop interface{}

+ LoopIndex int

+ LoopItem interface{}

+ Name string

+ NameGenerated bool

+ Register string

+ Rescue []*TaskEnvelope

+ Tags []string

+ Task Task

+ TypeName string

+ When string

+ func (e *TaskEnvelope) ChangedWhenProgram() *vm.Program

+ func (e *TaskEnvelope) FailedWhenProgram() *vm.Program

+ func (e *TaskEnvelope) HasChangedWhen() bool

+ func (e *TaskEnvelope) HasFailedWhen() bool

+ func (e *TaskEnvelope) HasTag(tag string) bool

+ func (e *TaskEnvelope) HasWhen() bool

+ func (e *TaskEnvelope) IntersectsTags(tags []string) bool

+ func (e *TaskEnvelope) IsGroup() bool

+ func (e *TaskEnvelope) WhenProgram() *vm.Program

+ type TaskExample interface

+ GetName func() string

+ type TaskOutputState struct

+ Changed bool

+ Commands []string

+ DesiredState State

+ Error error

+ ExitCode int

+ Message string

+ Meta struct{}

+ State State

+ Stderr string

+ Stdout string

+ Warnings []PlanWarning

+ func DispatchState(state State, funcMap map[State]func() TaskOutputState) TaskOutputState

+ func ExecutePlan(ctx context.Context, p PlanResult) (out TaskOutputState)

+ func TaskOutputErrorFromExec(state TaskOutputState, err error, result subprocess.ExecCommandResponse) TaskOutputState

+ type TaskSchema struct

+ Deprecation string

+ Examples []ExampleSchema

+ Export ExportSupport

+ Fields []FieldSchema

+ Identity IdentitySchema

+ MinimumDokkuVersion string

+ PluginRequirements []PluginRequirementSchema

+ Probe ProbeSupport

+ PropertySchema *PropertySchema

+ Requirements []string

+ Synopsis string

+ Type string

+ func TaskSchemaOf(typeKey string, task Task) (TaskSchema, error)

+ type ToggleContext struct

+ App string

+ type ToggleFields struct

+ App string

+ State State

+ type ToggleProbe func(ctx context.Context, tc ToggleContext) (enabled bool, err error)

+ type TraefikPropertyTask PropertyFields

+ func (t TraefikPropertyTask) Doc() string

+ func (t TraefikPropertyTask) Execute(ctx context.Context) TaskOutputState

+ func (t TraefikPropertyTask) ExportApp(ctx context.Context, app string) ([]interface{}, error)

+ func (t TraefikPropertyTask) ExportGlobal(ctx context.Context) ([]interface{}, error)

+ func (t TraefikPropertyTask) ExportSupport() ExportSupport

+ func (t TraefikPropertyTask) MinimumVersions() VersionSupport

+ func (t TraefikPropertyTask) Plan(ctx context.Context) PlanResult

+ func (t TraefikPropertyTask) ProbeSupport() ProbeSupport

+ func (t TraefikPropertyTask) Validate() error

+ type TraefikPropertyTaskExample struct

+ Name string

+ TraefikPropertyTask TraefikPropertyTask

+ func (e TraefikPropertyTaskExample) GetName() string

+ type ValidateOptions struct

+ Format string

+ InputOverrides map[string]bool

+ PlayName string

+ StartAtTask string

+ Strict bool

+ type VersionDocer interface

+ MinimumVersions func() VersionSupport

+ type VersionSupport struct

+ Dokku string

+ Plugins []PluginRequirement

+ func TaskMinimumVersions(t Task) (VersionSupport, bool)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL