schema

Documentation

Index

• Variables
• func ApplyProfiles(c *latest.SkaffoldConfig, ...) ([]string, map[string]configlocations.YAMLOverrideInfo, error)
• func IsCompatibleWith(cfgs []util.VersionedConfig, toVersion string) (bool, error)
• func IsSkaffoldConfig(file string) bool
• func ParseConfig(filename string) ([]util.VersionedConfig, error)
• func ParseConfigAndUpgrade(filename string) ([]util.VersionedConfig, error)
• func UpgradeTo(configs []util.VersionedConfig, toVersion string) ([]util.VersionedConfig, error)
• type APIVersion
• type Version
• type Versions
  • func (v *Versions) Find(apiVersion string) (func() util.VersionedConfig, bool)

Variables

var (
	AllVersions = append(SchemaVersionsV1, SchemaVersionsV2...)
	V1Pattern   = regexp.MustCompile(`skaffold/v[12]((alpha|beta)\d+)?`)
	V2Pattern   = regexp.MustCompile(`skaffold/v3((alpha|beta)\d+)?`)
)

var SchemaVersionsV1 = Versions{
	{v1alpha1.Version, v1alpha1.NewSkaffoldConfig},
	{v1alpha2.Version, v1alpha2.NewSkaffoldConfig},
	{v1alpha3.Version, v1alpha3.NewSkaffoldConfig},
	{v1alpha4.Version, v1alpha4.NewSkaffoldConfig},
	{v1alpha5.Version, v1alpha5.NewSkaffoldConfig},
	{v1beta1.Version, v1beta1.NewSkaffoldConfig},
	{v1beta2.Version, v1beta2.NewSkaffoldConfig},
	{v1beta3.Version, v1beta3.NewSkaffoldConfig},
	{v1beta4.Version, v1beta4.NewSkaffoldConfig},
	{v1beta5.Version, v1beta5.NewSkaffoldConfig},
	{v1beta6.Version, v1beta6.NewSkaffoldConfig},
	{v1beta7.Version, v1beta7.NewSkaffoldConfig},
	{v1beta8.Version, v1beta8.NewSkaffoldConfig},
	{v1beta9.Version, v1beta9.NewSkaffoldConfig},
	{v1beta10.Version, v1beta10.NewSkaffoldConfig},
	{v1beta11.Version, v1beta11.NewSkaffoldConfig},
	{v1beta12.Version, v1beta12.NewSkaffoldConfig},
	{v1beta13.Version, v1beta13.NewSkaffoldConfig},
	{v1beta14.Version, v1beta14.NewSkaffoldConfig},
	{v1beta15.Version, v1beta15.NewSkaffoldConfig},
	{v1beta16.Version, v1beta16.NewSkaffoldConfig},
	{v1beta17.Version, v1beta17.NewSkaffoldConfig},
	{v1.Version, v1.NewSkaffoldConfig},
	{v2alpha1.Version, v2alpha1.NewSkaffoldConfig},
	{v2alpha2.Version, v2alpha2.NewSkaffoldConfig},
	{v2alpha3.Version, v2alpha3.NewSkaffoldConfig},
	{v2alpha4.Version, v2alpha4.NewSkaffoldConfig},
	{v2beta1.Version, v2beta1.NewSkaffoldConfig},
	{v2beta2.Version, v2beta2.NewSkaffoldConfig},
	{v2beta3.Version, v2beta3.NewSkaffoldConfig},
	{v2beta4.Version, v2beta4.NewSkaffoldConfig},
	{v2beta5.Version, v2beta5.NewSkaffoldConfig},
	{v2beta6.Version, v2beta6.NewSkaffoldConfig},
	{v2beta7.Version, v2beta7.NewSkaffoldConfig},
	{v2beta8.Version, v2beta8.NewSkaffoldConfig},
	{v2beta9.Version, v2beta9.NewSkaffoldConfig},
	{v2beta10.Version, v2beta10.NewSkaffoldConfig},
	{v2beta11.Version, v2beta11.NewSkaffoldConfig},
	{v2beta12.Version, v2beta12.NewSkaffoldConfig},
	{v2beta13.Version, v2beta13.NewSkaffoldConfig},
	{v2beta14.Version, v2beta14.NewSkaffoldConfig},
	{v2beta15.Version, v2beta15.NewSkaffoldConfig},
	{v2beta16.Version, v2beta16.NewSkaffoldConfig},
	{v2beta17.Version, v2beta17.NewSkaffoldConfig},
	{v2beta18.Version, v2beta18.NewSkaffoldConfig},
	{v2beta19.Version, v2beta19.NewSkaffoldConfig},
	{v2beta20.Version, v2beta20.NewSkaffoldConfig},
	{v2beta21.Version, v2beta21.NewSkaffoldConfig},
	{v2beta22.Version, v2beta22.NewSkaffoldConfig},
	{v2beta23.Version, v2beta23.NewSkaffoldConfig},
	{v2beta24.Version, v2beta24.NewSkaffoldConfig},
	{v2beta25.Version, v2beta25.NewSkaffoldConfig},
	{v2beta26.Version, v2beta26.NewSkaffoldConfig},
	{v2beta27.Version, v2beta27.NewSkaffoldConfig},
	{v2beta28.Version, v2beta28.NewSkaffoldConfig},
	{latest.Version, latest.NewSkaffoldConfig},
}

SchemaVersionsV1 refers to all the supported API Schemas for skaffold v1 executables.e.g. skaffold 1.13. The API schema versions are in the range of v1alpha*, v1beta*, v2alpha* and v2beta*.

var SchemaVersionsV2 = Versions{
	{v3alpha1.Version, v3alpha1.NewSkaffoldConfig},
	{latestV2.Version, latestV2.NewSkaffoldConfig},
}

SchemaVersionsV2 refers to all the supported API Schemas for skaffold v2 executables. The API schema versions are in the range of v3alpha*.

Functions

func ApplyProfiles

func ApplyProfiles(c *latest.SkaffoldConfig, fieldsOverrodeByProfile map[string]configlocations.YAMLOverrideInfo, opts cfg.SkaffoldOptions, namedProfiles []string) ([]string, map[string]configlocations.YAMLOverrideInfo, error)

ApplyProfiles modifies the input skaffold configuration by the application of a list of profiles, and returns the list of applied profiles.

func IsCompatibleWith

func IsCompatibleWith(cfgs []util.VersionedConfig, toVersion string) (bool, error)

IsCompatibleWith checks if the cfgs versions can be upgraded to toVersion.

func IsSkaffoldConfig

func IsSkaffoldConfig(file string) bool

IsSkaffoldConfig is for determining if a file is skaffold config file.

func ParseConfig

func ParseConfig(filename string) ([]util.VersionedConfig, error)

ParseConfig reads a configuration file.

func ParseConfigAndUpgrade

func ParseConfigAndUpgrade(filename string) ([]util.VersionedConfig, error)

ParseConfigAndUpgrade reads a configuration file and upgrades it to a given version.

func UpgradeTo

func UpgradeTo(configs []util.VersionedConfig, toVersion string) ([]util.VersionedConfig, error)

UpgradeTo upgrades the given configs to toVersion.

Types

type APIVersion

type APIVersion struct {
	Version string `yaml:"apiVersion"`
}

type Version

type Version struct {
	APIVersion string
	Factory    func() util.VersionedConfig
}

type Versions

type Versions []Version

func (*Versions) Find

func (v *Versions) Find(apiVersion string) (func() util.VersionedConfig, bool)

Find search the constructor for a given api version.