base

Documentation

Index

• Variables
• func AddBundlePart(baseDir string, filename string, content []byte) error
• func FindObjectsWithImages(b *Base) []k8sdoc.K8sDoc
• func NewConfigContextTemplateBuilder(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (*template.Builder, map[string]template.ItemValue, error)
• func RenderUpstream(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (base *Base, helmBases []Base, err error)
• type Base
  • func RenderHelm(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (*Base, error)
  • func (b *Base) GetOverlaysDir(options WriteOptions) string
  • func (b Base) ListErrorFiles() []BaseFile
  • func (b *Base) WriteBase(options WriteOptions) error
• type BaseFile
  • func PrependBaseFilesPath(files []BaseFile, prefix string) []BaseFile
  • func (f BaseFile) IsKotsKind() (bool, error)
  • func (f BaseFile) ShouldBeIncludedInBaseKustomization(excludeKotsKinds bool) (bool, error)
• type Document
• type FindPrivateImagesOptions
• type FindPrivateImagesResult
  • func FindPrivateImages(options FindPrivateImagesOptions) (*FindPrivateImagesResult, error)
• type HelmSubCharts
  • func FindHelmSubChartsFromBase(baseDir, parentChart string) (*HelmSubCharts, error)
• type OverlySimpleGVK
  • func GetGVKWithNameAndNs(content []byte, baseNS string) (string, OverlySimpleGVK)
• type OverlySimpleMetadata
• type ParseError
  • func (e ParseError) Error() string
• type RenderOptions
• type SkippedFile
• type SkippedFilesIndex
• type WriteOptions
• type WriteUpstreamImageOptions
• type WriteUpstreamImageResult
  • func ProcessUpstreamImages(options WriteUpstreamImageOptions) (*WriteUpstreamImageResult, error)

Variables

var (
	HelmV3ManifestNameRegex = regexp.MustCompile("^# Source: (.+)")
)

Functions

func AddBundlePart

func AddBundlePart(baseDir string, filename string, content []byte) error

func FindObjectsWithImages

func FindObjectsWithImages(b *Base) []k8sdoc.K8sDoc

func NewConfigContextTemplateBuilder

func NewConfigContextTemplateBuilder(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (*template.Builder, map[string]template.ItemValue, error)

func RenderUpstream

func RenderUpstream(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (base *Base, helmBases []Base, err error)

RenderUpstream is responsible for any conversions or transpilation steps are required to take an upstream and make it a valid kubernetes base

Types

type Base

type Base struct {
	Path            string
	Namespace       string
	Files           []BaseFile
	ErrorFiles      []BaseFile
	AdditionalFiles []BaseFile
	Bases           []Base
}

func RenderHelm

func RenderHelm(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (*Base, error)

func (*Base) GetOverlaysDir

func (b *Base) GetOverlaysDir(options WriteOptions) string

func (Base) ListErrorFiles

func (b Base) ListErrorFiles() []BaseFile

func (*Base) WriteBase

func (b *Base) WriteBase(options WriteOptions) error

type BaseFile

type BaseFile struct {
	Path    string
	Content []byte
	Error   error
}

func PrependBaseFilesPath

func PrependBaseFilesPath(files []BaseFile, prefix string) []BaseFile

func (BaseFile) IsKotsKind

func (f BaseFile) IsKotsKind() (bool, error)

func (BaseFile) ShouldBeIncludedInBaseKustomization

func (f BaseFile) ShouldBeIncludedInBaseKustomization(excludeKotsKinds bool) (bool, error)

ShouldBeIncludedInBaseKustomization attempts to determine if this is a valid Kubernetes manifest. It accomplished this by trying to unmarshal the YAML and looking for a apiVersion and Kind

type Document

type Document struct {
	APIVersion string `yaml:"apiVersion"`
	Kind       string `yaml:"kind"`
}

type FindPrivateImagesOptions

type FindPrivateImagesOptions struct {
	BaseDir            string
	AppSlug            string
	ReplicatedRegistry registry.RegistryOptions
	DockerHubRegistry  registry.RegistryOptions
	Installation       *kotsv1beta1.Installation
	AllImagesPrivate   bool
	UseHelmInstall     map[string]bool
}

type FindPrivateImagesResult

type FindPrivateImagesResult struct {
	Images        []kustomizeimage.Image          // images to be rewritten
	Docs          []k8sdoc.K8sDoc                 // docs that have rewritten images
	CheckedImages []kotsv1beta1.InstallationImage // all images found in the installation
}

func FindPrivateImages

func FindPrivateImages(options FindPrivateImagesOptions) (*FindPrivateImagesResult, error)

type HelmSubCharts

type HelmSubCharts struct {
	ParentName string
	SubCharts  []string
}

func FindHelmSubChartsFromBase

func FindHelmSubChartsFromBase(baseDir, parentChart string) (*HelmSubCharts, error)

type OverlySimpleGVK

type OverlySimpleGVK struct {
	APIVersion string               `yaml:"apiVersion"`
	Kind       string               `yaml:"kind"`
	Metadata   OverlySimpleMetadata `yaml:"metadata"`
}

func GetGVKWithNameAndNs

func GetGVKWithNameAndNs(content []byte, baseNS string) (string, OverlySimpleGVK)

type OverlySimpleMetadata

type OverlySimpleMetadata struct {
	Name        string                 `yaml:"name"`
	Namespace   string                 `yaml:"namespace"`
	Annotations map[string]interface{} `json:"annotations"`
}

type ParseError

type ParseError struct {
	Err error
}

func (ParseError) Error

func (e ParseError) Error() string

type RenderOptions

type RenderOptions struct {
	SplitMultiDocYAML       bool
	Namespace               string
	HelmVersion             string
	HelmOptions             []string
	HelmValues              map[string]interface{}
	LocalRegistryHost       string
	LocalRegistryNamespace  string
	LocalRegistryUsername   string
	LocalRegistryPassword   string
	LocalRegistryIsReadOnly bool
	ExcludeKotsKinds        bool
	AppSlug                 string
	Sequence                int64
	IsAirgap                bool
	Log                     *logger.CLILogger
}

type SkippedFile

type SkippedFile struct {
	Path   string `yaml:"path"`
	Reason string `yaml:"reason"`
}

type SkippedFilesIndex

type SkippedFilesIndex struct {
	SkippedFiles []SkippedFile `yaml:"skippedFiles"`
}

type WriteOptions

type WriteOptions struct {
	BaseDir          string
	SkippedDir       string
	Overwrite        bool
	ExcludeKotsKinds bool
	IsHelmBase       bool
}

type WriteUpstreamImageOptions

type WriteUpstreamImageOptions struct {
	BaseDir           string
	AppSlug           string
	SourceRegistry    registry.RegistryOptions
	DestRegistry      registry.RegistryOptions
	DockerHubRegistry registry.RegistryOptions
	CopyImages        bool
	IsAirgap          bool
	Log               *logger.CLILogger
	ReportWriter      io.Writer
	Installation      *kotsv1beta1.Installation
	Application       *kotsv1beta1.Application
}

type WriteUpstreamImageResult

type WriteUpstreamImageResult struct {
	Images        []kustomizeimage.Image          // images to be rewritten
	CheckedImages []kotsv1beta1.InstallationImage // all images found in the installation
}

func ProcessUpstreamImages

func ProcessUpstreamImages(options WriteUpstreamImageOptions) (*WriteUpstreamImageResult, error)