builder

Documentation

Index

• Constants
• func BuildResource(tmpl *apix.JSON, inputs map[string]any) (*unstructured.Unstructured, error)
• func BuildResourceSet(yamlTemplate string, templates []*apix.JSON, inputs []map[string]any) ([]*unstructured.Unstructured, error)
• func BuildResourcesFromYAML(yamlTemplate string, inputs map[string]any) ([]*unstructured.Unstructured, error)
• func ContainElementString(s []string, e string) bool
• func GetArtifactDigest(ctx context.Context, ociURL string, keyChain authn.Keychain) (string, error)
• func GetMultitenantProfile(defaultSA string) string
• func GetNotificationPatch(namespace string) string
• func IsCompatibleVersion(fromVer, toVer string) error
• func MatchVersion(dataDir, semverRange string) (string, error)
• func MkdirTempAbs(dir, pattern string) (string, error)
• func PullArtifact(ctx context.Context, ociURL, dstDir string, keyChain authn.Keychain) (string, error)
• type ArtifactStorage
• type ComponentImage
  • func ExtractComponentImages(srcDir string, opts Options) ([]ComponentImage, error)
  • func ExtractComponentImagesWithDigest(srcDir string, opts Options) (images []ComponentImage, err error)
• type Options
  • func MakeDefaultOptions() Options
• type Result
  • func Build(srcDir, tmpDir string, options Options) (*Result, error)
• type Sync

Constants

const ProfileOpenShift = `` /* 501-byte string literal not displayed */

Functions

func BuildResource

func BuildResource(tmpl *apix.JSON, inputs map[string]any) (*unstructured.Unstructured, error)

BuildResource builds a Kubernetes resource from a JSON template using the provided inputs. Template functions are provided by the slim-sprig library https://go-task.github.io/slim-sprig/. In addition, the slugify function is available to generate slugs from strings using https://github.com/gosimple/slug/. And for readability, a toYaml function is available to encode an input value into a YAML string.

func BuildResourceSet

func BuildResourceSet(yamlTemplate string, templates []*apix.JSON, inputs []map[string]any) ([]*unstructured.Unstructured, error)

BuildResourceSet builds a list of Kubernetes resources from a list of JSON templates using the provided inputs.

func BuildResourcesFromYAML

func BuildResourcesFromYAML(yamlTemplate string, inputs map[string]any) ([]*unstructured.Unstructured, error)

BuildResourcesFromYAML builds a list of Kubernetes resources from a multi-doc YAML template using the same templating functions as BuildResource.

func ContainElementString

func ContainElementString(s []string, e string) bool

func GetArtifactDigest

func GetArtifactDigest(ctx context.Context, ociURL string, keyChain authn.Keychain) (string, error)

GetArtifactDigest looks up an artifact from an OCI repository and returns the digest of the artifact.

func GetMultitenantProfile

func GetMultitenantProfile(defaultSA string) string

func GetNotificationPatch

func GetNotificationPatch(namespace string) string

func IsCompatibleVersion

func IsCompatibleVersion(fromVer, toVer string) error

IsCompatibleVersion checks if the version upgrade is compatible. It returns an error if a downgrade to a lower minor version is attempted.

func MatchVersion

func MatchVersion(dataDir, semverRange string) (string, error)

MatchVersion returns the latest version dir path that matches the given semver range.

func MkdirTempAbs

func MkdirTempAbs(dir, pattern string) (string, error)

MkdirTempAbs creates a tmp dir and returns the absolute path to the dir. This is required since certain OSes like MacOS create temporary files in e.g. `/private/var`, to which `/var` is a symlink.

func PullArtifact

func PullArtifact(ctx context.Context, ociURL, dstDir string, keyChain authn.Keychain) (string, error)

PullArtifact downloads an artifact from an OCI repository and extracts the content of the first tgz layer to the given destination directory. It returns the digest of the artifact.

Types

type ArtifactStorage

type ArtifactStorage struct {
	Class string
	Size  string
}

ArtifactStorage represents the source-controller PVC.

type ComponentImage

type ComponentImage struct {
	Name       string
	Repository string
	Tag        string
	Digest     string
}

ComponentImage represents a container image used by a component.

func ExtractComponentImages

func ExtractComponentImages(srcDir string, opts Options) ([]ComponentImage, error)

ExtractComponentImages reads the source directory and extracts the container images from the components manifests.

func ExtractComponentImagesWithDigest

func ExtractComponentImagesWithDigest(srcDir string, opts Options) (images []ComponentImage, err error)

ExtractComponentImagesWithDigest reads the source directory and extracts the container images with digest from the kustomize images patches.

type Options

type Options struct {
	Version                string
	Namespace              string
	Components             []string
	ComponentImages        []ComponentImage
	EventsAddr             string
	Registry               string
	ImagePullSecret        string
	WatchAllNamespaces     bool
	NetworkPolicy          bool
	LogLevel               string
	NotificationController string
	ClusterDomain          string
	TolerationKeys         []string
	Patches                string
	ArtifactStorage        *ArtifactStorage
	Sync                   *Sync
	ShardingKey            string
	Shards                 []string
	ShardName              string
}

Options defines the builder configuration.

func MakeDefaultOptions

func MakeDefaultOptions() Options

MakeDefaultOptions returns the default builder configuration.

type Result

type Result struct {
	Version         string
	Digest          string
	Revision        string
	Objects         []*unstructured.Unstructured
	ComponentImages []ComponentImage
}

Result holds the build result.

func Build

func Build(srcDir, tmpDir string, options Options) (*Result, error)

Build copies the source directory to a temporary directory, generates the required manifests and runs kustomize to build the final resources. The function returns a slice of unstructured objects.

type Sync

type Sync struct {
	Name       string
	Kind       string
	URL        string
	Ref        string
	Path       string
	Interval   string
	PullSecret string
	Provider   string
}