manifest

Jun 23, 2024

Changes in this version

type Manifest

+ func (m *Manifest) GetTemplateParameterName(value string) (string, bool)

+ func (m *Manifest) GetTemplatedParameters() ParameterDefinitions

+ func (m *Manifest) ScanManifestTemplating(data []byte) (templateScanResult, error)

Apr 10, 2023

Changes in this version

type BundleCriteria

+ Interface *BundleInterface

+ type BundleInterface struct

+ Document *BundleInterfaceDocument

+ ID string

+ Reference string

+ type BundleInterfaceDocument struct

+ Credentials CredentialDefinitions

+ Outputs OutputDefinitions

+ Parameters ParameterDefinitions

type Dependencies

+ Provides *DependencyProvider

type Dependency

+ Credentials map[string]string

+ Outputs map[string]string

+ Sharing SharingCriteria

+ func (d *Dependency) UsesV2Features() bool

+ type DependencyProvider struct

+ Interface InterfaceDeclaration

+ type DependencySource string

+ type InterfaceDeclaration struct

+ ID string

type Manifest

+ func (m *Manifest) DetermineDependenciesExtensionUsed() string

+ type SharingCriteria struct

+ Group SharingGroup

+ Mode string

+ func (s SharingCriteria) GetEffectiveMode() string

+ type SharingGroup struct

+ Name string

Feb 14, 2023

Changes in this version

+ const SchemaTypeBundle

type Manifest

+ SchemaType string

Oct 11, 2022

Changes in this version

+ const TemplateDelimiterPrefix

+ var DefaultSchemaVersion = semver.MustParse("1.0.0")

+ var SupportedSchemaVersions = semver.NewConstraint("1.0.0-alpha.1 || 1.0.0")

+ func ResolvePath(value string) string

+ type BundleCriteria struct

+ Reference string

+ Version string

+ type Dependencies struct

+ Requires []*Dependency

type Dependency

+ Bundle BundleCriteria

+ type MaintainerDefinition struct

+ Email string

+ Name string

+ Url string

type Manifest

+ Maintainers []MaintainerDefinition

+ SchemaVersion string

+ StateBag StateBag

+ func (m *Manifest) GetTemplatePrefix() string

type MappedImage

+ func (mi *MappedImage) ToOCIReference() (cnab.OCIReference, error)

type OutputDefinition

+ IsState bool

type ParameterDefinition

+ IsState bool

+ type StateBag []StateVariable

+ type StateVariable struct

+ Description string

+ Mixin string

+ Name string

Jul 12, 2021

Changes in this version

type ParameterDefinition

+ func (pd *ParameterDefinition) GetApplyTo() []string

Mar 18, 2021

Changes in this version

type CredentialDefinition

+ ApplyTo []string

+ type CustomDefinitions map[string]interface

+ func (cd *CustomDefinitions) UnmarshalYAML(unmarshal func(interface{}) error) error

Jan 13, 2021

Changes in this version

+ type Editor struct

+ func NewEditor(cxt *context.Context) *Editor

+ func (e *Editor) Read(data []byte) (n int, err error)

+ func (e *Editor) ReadFile(src string) error

+ func (e *Editor) SetValue(path string, value string) error

+ func (e *Editor) WriteFile(dest string) error

type Manifest

+ DockerTag string

Oct 29, 2020

Changes in this version

type Dependency

+ Reference string

type Manifest

+ Reference string

+ Registry string

+ func (m *Manifest) SetInvocationImageAndReference(ref string) error

type MappedImage

+ ContentDigest string

Sep 9, 2020

Changes in this version

type Dependency

+ Name string

Aug 25, 2020

Changes in this version

+ func GetParameterSourceForDependency(ref DependencyOutputReference) string

+ func GetParameterSourceForOutput(outputName string) string

+ func ParamToEnvVar(name string) string

+ type CredentialDefinitions map[string]CredentialDefinition

+ func (cd *CredentialDefinitions) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (cd CredentialDefinitions) MarshalYAML() (interface{}, error)

+ type DependencyOutputReference struct

+ Dependency string

+ Output string

+ func (r DependencyOutputReference) String() string

+ type DependencyOutputReferences map[string]DependencyOutputReference

type Manifest

+ TemplateVariables []string

+ func (m *Manifest) GetTemplatedDependencyOutputs() DependencyOutputReferences

+ func (m *Manifest) GetTemplatedOutputs() OutputDefinitions

+ type OutputDefinitions map[string]OutputDefinition

+ func (od *OutputDefinitions) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (od OutputDefinitions) MarshalYAML() (interface{}, error)

type ParameterDefinition

+ Source ParameterSource

+ func (pd *ParameterDefinition) UpdateApplyTo(m *Manifest)

+ type ParameterDefinitions map[string]ParameterDefinition

+ func (pd *ParameterDefinitions) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (pd ParameterDefinitions) MarshalYAML() (interface{}, error)

+ type ParameterSource struct

+ Dependency string

+ Output string

Jul 21, 2020

Changes in this version

type Manifest

+ func (m *Manifest) SetInvocationImageFromBundleTag(bundleTag string) error

Jun 25, 2020

Changes in this version

+ func IsCoreAction(value Action) bool

+ func ReadManifestData(cxt *context.Context, path string) ([]byte, error)

+ type Action string

+ const ActionInstall

+ const ActionUninstall

+ const ActionUpgrade

+ func GetCoreActions() []Action

+ type BundleOutput struct

+ EnvironmentVariable string

+ Name string

+ Path string

+ type CredentialDefinition struct

+ Description string

+ Name string

+ Required bool

+ func (cd *CredentialDefinition) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type CustomActionDefinition struct

+ Description string

+ ModifiesResources bool

+ Stateless bool

+ type Dependency struct

+ AllowPrereleases bool

+ Parameters map[string]string

+ Tag string

+ Versions []string

+ func (d *Dependency) Validate() error

+ type Location struct

+ EnvironmentVariable string

+ Path string

+ func (l Location) IsEmpty() bool

+ type Manifest struct

+ BundleTag string

+ Credentials []CredentialDefinition

+ Custom map[string]interface{}

+ CustomActionDefinitions map[string]CustomActionDefinition

+ CustomActions map[string]Steps

+ Dependencies map[string]Dependency

+ Description string

+ Dockerfile string

+ Image string

+ ImageMap map[string]MappedImage

+ Install Steps

+ ManifestPath string

+ Mixins []MixinDeclaration

+ Name string

+ Outputs []OutputDefinition

+ Parameters []ParameterDefinition

+ Required []RequiredExtension

+ Uninstall Steps

+ Upgrade Steps

+ Version string

+ func LoadManifestFrom(cxt *context.Context, file string) (*Manifest, error)

+ func ReadManifest(cxt *context.Context, path string) (*Manifest, error)

+ func UnmarshalManifest(manifestData []byte) (*Manifest, error)

+ func (m *Manifest) SetDefaults() error

+ func (m *Manifest) Validate() error

+ type MappedImage struct

+ Description string

+ Digest string

+ ImageType string

+ Labels map[string]string

+ MediaType string

+ Repository string

+ Size uint64

+ Tag string

+ func (mi *MappedImage) Validate() error

+ type MixinDeclaration struct

+ Config interface{}

+ Name string

+ func (m *MixinDeclaration) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (m MixinDeclaration) MarshalYAML() (interface{}, error)

+ type OutputDefinition struct

+ ApplyTo []string

+ Name string

+ Path string

+ Sensitive bool

+ func (od *OutputDefinition) DeepCopy() *OutputDefinition

+ func (od *OutputDefinition) Validate() error

+ type ParameterDefinition struct

+ ApplyTo []string

+ Destination Location

+ Name string

+ Sensitive bool

+ func (pd *ParameterDefinition) AppliesTo(action string) bool

+ func (pd *ParameterDefinition) DeepCopy() *ParameterDefinition

+ func (pd *ParameterDefinition) Validate() error

+ type RequiredExtension struct

+ Config map[string]interface{}

+ Name string

+ func (r *RequiredExtension) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Step struct

+ Data map[string]interface{}

+ func (s *Step) GetDescription() (string, error)

+ func (s *Step) GetMixinName() string

+ func (s *Step) Validate(m *Manifest) error

+ type Steps []*Step

+ func (s Steps) Validate(m *Manifest) error