distribution

Documentation

Index

• Constants
• Variables
• func GetConfigTemplatePath(basePath string, conf config.Furyctl) (string, error)
• func GetPrivateSchemaPath(basePath string, conf config.Furyctl) (string, error)
• func GetPublicSchemaPath(basePath string, conf config.Furyctl) (string, error)
• func HasFeature(kfd config.KFD, name Feature) bool
• type CompatibilityCheck
• type CompatibilityChecker
  • func NewCompatibilityChecker(distributionVersion, kind string) (CompatibilityChecker, error)
• type DownloadResult
• type Downloader
  • func NewCachingDownloader(client netx.Client, outDir string, gitProtocol git.Protocol, ...) *Downloader
  • func NewDownloader(client netx.Client, gitProtocol git.Protocol, customDistroPatchesPath string) *Downloader
  • func (d *Downloader) DoDownload(distroLocation string, minimalConf config.Furyctl) (DownloadResult, error)
  • func (d *Downloader) Download(distroLocation string, furyctlConfPath string) (DownloadResult, error)
• type EKSClusterCheck
  • func NewEKSClusterCheck(distributionVersion string) *EKSClusterCheck
  • func (c *EKSClusterCheck) IsCompatible() bool
• type Feature
• type IACBuilder
  • func NewIACBuilder(furyctlFile map[any]any, distroPath, kind, outDir, furyctlConfPath string, ...) (*IACBuilder, error)
  • func (m *IACBuilder) Build() error
• type KFDDistributionCheck
  • func NewKFDDistributionCheck(distributionVersion string) *KFDDistributionCheck
  • func (c *KFDDistributionCheck) IsCompatible() bool
• type OnPremisesCheck
  • func NewOnPremisesCheck(distributionVersion string) *OnPremisesCheck
  • func (c *OnPremisesCheck) IsCompatible() bool

Constants

const (
	EKSClusterKind      = "EKSCluster"
	KFDDistributionKind = "KFDDistribution"
	OnPremisesKind      = "OnPremises"
)

const (
	FeatureClusterUpgrade     = Feature("ClusterUpgrade")
	FeatureTracingModule      = Feature("TracingModule")
	FeatureKubeconfigInSchema = Feature("KubeconfigInSchema")
	FeaturePlugins            = Feature("Plugins")
	FeatureYqSupport          = Feature("YqSupport")
	FeatureKubernetesLogTypes = Feature("KubernetesLogTypes")
)

const DefaultBaseURL = "git::%s/fury-distribution?ref=%s&depth=1"

const ValidLength = 2

Variables

var (
	ErrCannotDownloadDistribution = errors.New("cannot download distribution")
	ErrChangingFilePermissions    = errors.New("error changing file permissions")
	ErrCreatingTempDir            = errors.New("error creating temp dir")
	ErrDownloadingFolder          = errors.New("error downloading folder")
	ErrMergeCompleteConfig        = errors.New("error merging complete config")
	ErrMergeDistroConfig          = errors.New("error merging distribution config")
	ErrRenamingFile               = errors.New("error renaming file")
	ErrResolvingAbsPath           = errors.New("error resolving absolute path")
	ErrValidateConfig             = errors.New("error validating config")
	ErrWriteFile                  = errors.New("error writing file")
	ErrYamlMarshalFile            = errors.New("error marshaling yaml file")
	ErrYamlUnmarshalFile          = errors.New("error unmarshaling yaml file")
	ErrUnsupportedVersion         = errors.New("unsupported KFD version")
)

var (
	ErrSourceDirDoesNotExist = errors.New("source directory does not exist")
	ErrInvalidKind           = errors.New("invalid kind")
)

var ErrPluginsFeatureNotSupported = errors.New("plugins feature not supported")

var ErrUnsupportedKind = errors.New("unsupported kind")

Functions

func GetConfigTemplatePath

func GetConfigTemplatePath(basePath string, conf config.Furyctl) (string, error)

func GetPrivateSchemaPath

func GetPrivateSchemaPath(basePath string, conf config.Furyctl) (string, error)

func GetPublicSchemaPath

func GetPublicSchemaPath(basePath string, conf config.Furyctl) (string, error)

func HasFeature

func HasFeature(kfd config.KFD, name Feature) bool

Types

type CompatibilityCheck

type CompatibilityCheck struct {
	// contains filtered or unexported fields
}

type CompatibilityChecker

type CompatibilityChecker interface {
	IsCompatible() bool
}

func NewCompatibilityChecker

func NewCompatibilityChecker(distributionVersion, kind string) (CompatibilityChecker, error)

type DownloadResult

type DownloadResult struct {
	RepoPath       string
	MinimalConf    config.Furyctl
	DistroManifest config.KFD
}

type Downloader

type Downloader struct {
	// contains filtered or unexported fields
}

func NewCachingDownloader

func NewCachingDownloader(
	client netx.Client,
	outDir string,
	gitProtocol git.Protocol,
	customDistroPatchesPath string,
) *Downloader

func NewDownloader

func NewDownloader(client netx.Client, gitProtocol git.Protocol, customDistroPatchesPath string) *Downloader

func (*Downloader) DoDownload

func (d *Downloader) DoDownload(
	distroLocation string,
	minimalConf config.Furyctl,
) (DownloadResult, error)

func (*Downloader) Download

func (d *Downloader) Download(
	distroLocation string,
	furyctlConfPath string,
) (DownloadResult, error)

type EKSClusterCheck

type EKSClusterCheck struct {
	CompatibilityCheck
}

func NewEKSClusterCheck

func NewEKSClusterCheck(distributionVersion string) *EKSClusterCheck

func (*EKSClusterCheck) IsCompatible

func (c *EKSClusterCheck) IsCompatible() bool

type Feature

type Feature string

type IACBuilder

type IACBuilder struct {
	// contains filtered or unexported fields
}

func NewIACBuilder

func NewIACBuilder(
	furyctlFile map[any]any,
	distroPath,
	kind,
	outDir,
	furyctlConfPath string,
	noOverwrite,
	dryRun bool,
) (*IACBuilder, error)

func (*IACBuilder) Build

func (m *IACBuilder) Build() error

type KFDDistributionCheck

type KFDDistributionCheck struct {
	CompatibilityCheck
}

func NewKFDDistributionCheck

func NewKFDDistributionCheck(distributionVersion string) *KFDDistributionCheck

func (*KFDDistributionCheck) IsCompatible

func (c *KFDDistributionCheck) IsCompatible() bool

type OnPremisesCheck

type OnPremisesCheck struct {
	CompatibilityCheck
}

func NewOnPremisesCheck

func NewOnPremisesCheck(distributionVersion string) *OnPremisesCheck

func (*OnPremisesCheck) IsCompatible

func (c *OnPremisesCheck) IsCompatible() bool