library

Documentation

Index

• func CloneRemoteStack(git *schema.Git, path string, verbose bool) (err error)
• func CreateIndexFile(index []schema.Schema, indexFilePath string) error
• func DownloadStackFromGit(git *schema.Git, path string, verbose bool) ([]byte, error)
• func DownloadStackFromZipUrl(zipUrl string, subDir string, path string) ([]byte, error)
• func GenerateIndexStruct(registryDirPath string, force bool) ([]schema.Schema, error)
• func GitSubDir(srcPath, destinationPath, subDir string) error
• func SetLastModifiedValue(index []schema.Schema, registryDirPath string) ([]schema.Schema, error)
• func SortVersionByDescendingOrder(versions []schema.Version) []schema.Version
• func StartSignalWatcher(watchSignals []os.Signal, handle func(receivedSignal os.Signal))
• func ZipDir(src string, dst string) error
• type IconUrlBrokenError
  • func (e *IconUrlBrokenError) Error() string
• type InvalidDeploymentScopes
  • func (e *InvalidDeploymentScopes) Error() string
• type MissingArchError
  • func (e *MissingArchError) Error() string
• type MissingProviderError
  • func (e *MissingProviderError) Error() string
• type MissingSupportUrlError
  • func (e *MissingSupportUrlError) Error() string
• type Semver
• type TooManyDeploymentScopes
  • func (e *TooManyDeploymentScopes) Error() string

Functions

func CloneRemoteStack

func CloneRemoteStack(git *schema.Git, path string, verbose bool) (err error)

CloneRemoteStack downloads the stack version from a git repo outside of the registry by cloning then removing the local .git folder. When git.SubDir is set, fetches specified subdirectory only.

func CreateIndexFile

func CreateIndexFile(index []schema.Schema, indexFilePath string) error

CreateIndexFile creates index file in disk

func DownloadStackFromGit

func DownloadStackFromGit(git *schema.Git, path string, verbose bool) ([]byte, error)

DownloadStackFromGit downloads the stack from a git repo then adds folder contents into a zip archive, returns byte array of zip file and error if occurs otherwise is nil. If git.SubDir is set, then zip file will contain contents of the specified subdirectory instead of the whole downloaded git repo.

func DownloadStackFromZipUrl

func DownloadStackFromZipUrl(zipUrl string, subDir string, path string) ([]byte, error)

DownloadStackFromZipUrl downloads the zip file containing the stack at a given url, uses default filesystem

func GenerateIndexStruct

func GenerateIndexStruct(registryDirPath string, force bool) ([]schema.Schema, error)

GenerateIndexStruct parses registry then generates index struct according to the schema

func GitSubDir

func GitSubDir(srcPath, destinationPath, subDir string) error

GitSubDir handles subDir for git components using the default filesystem

func SetLastModifiedValue

func SetLastModifiedValue(index []schema.Schema, registryDirPath string) ([]schema.Schema, error)

SetLastModifiedValue adds the last modified value to a pre-created index The last modified dates are contained in a file named last_modified.json that is apart of the registry dir

#nosec G304 -- lastModFile is produced from filepath.Join which cleans the input path

func SortVersionByDescendingOrder

func SortVersionByDescendingOrder(versions []schema.Version) []schema.Version

func StartSignalWatcher

func StartSignalWatcher(watchSignals []os.Signal, handle func(receivedSignal os.Signal))

StartSignalWatcher watches for signals and handles the situation before exiting the program

func ZipDir

func ZipDir(src string, dst string) error

ZipDir creates a zip file from a given directory specified by the src argument into a zip archive specified by the *dst* argument, uses default filesystem

Types

type IconUrlBrokenError

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

func (*IconUrlBrokenError) Error

func (e *IconUrlBrokenError) Error() string

type InvalidDeploymentScopes

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

InvalidDeploymentScopes error type for when deploymentScopes contains any incorrect kinds

func (*InvalidDeploymentScopes) Error

func (e *InvalidDeploymentScopes) Error() string

type MissingArchError

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

MissingArchError is an error if the architecture list is empty

func (*MissingArchError) Error

func (e *MissingArchError) Error() string

type MissingProviderError

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

MissingProviderError is an error if the provider field is missing

func (*MissingProviderError) Error

func (e *MissingProviderError) Error() string

type MissingSupportUrlError

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

MissingSupportUrlError is an error if the supportUrl field is missing

func (*MissingSupportUrlError) Error

func (e *MissingSupportUrlError) Error() string

type Semver

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

type TooManyDeploymentScopes

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

TooManyDeploymentScopes error type for when there are deploymentScopes set at once

func (*TooManyDeploymentScopes) Error

func (e *TooManyDeploymentScopes) Error() string