base

Documentation

Index

• func AddBundlePart(baseDir string, filename string, content []byte) error
• func FindObjectsWithImages(options FindObjectsWithImagesOptions) ([]*k8sdoc.Doc, error)
• func GetGVKWithNameAndNs(content []byte, baseNS string) string
• func UnmarshalConfigValuesContent(content []byte) (map[string]template.ItemValue, error)
• func UnmarshalLicenseContent(content []byte, log *logger.Logger) *kotsv1beta1.License
• type Base
  • func RenderHelm(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (*Base, error)
  • func RenderUpstream(u *upstreamtypes.Upstream, renderOptions *RenderOptions) (*Base, error)
  • func (b *Base) GetOverlaysDir(options WriteOptions) string
  • func (b *Base) WriteBase(options WriteOptions) error
• type BaseFile
  • func (f BaseFile) ShouldBeIncludedInBaseKustomization(excludeKotsKinds bool) (bool, error)
• type Document
• type FindObjectsWithImagesOptions
• type FindPrivateImagesOptions
• type FindPrivateImagesResult
  • func FindPrivateImages(options FindPrivateImagesOptions) (*FindPrivateImagesResult, error)
• type OverlySimpleGVK
• type OverlySimpleMetadata
• type RenderOptions
• type WriteOptions
• type WriteUpstreamImageOptions
• type WriteUpstreamImageResult
  • func CopyUpstreamImages(options WriteUpstreamImageOptions) (*WriteUpstreamImageResult, error)

Functions

func AddBundlePart

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

func FindObjectsWithImages

func FindObjectsWithImages(options FindObjectsWithImagesOptions) ([]*k8sdoc.Doc, error)

func GetGVKWithNameAndNs

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

func UnmarshalConfigValuesContent

func UnmarshalConfigValuesContent(content []byte) (map[string]template.ItemValue, error)

func UnmarshalLicenseContent

func UnmarshalLicenseContent(content []byte, log *logger.Logger) *kotsv1beta1.License

Types

type Base

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

func RenderHelm

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

func RenderUpstream

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

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

func (*Base) GetOverlaysDir

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

func (*Base) WriteBase

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

type BaseFile

type BaseFile struct {
	Path    string
	Content []byte
}

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 FindObjectsWithImagesOptions

type FindObjectsWithImagesOptions struct {
	BaseDir string
}

type FindPrivateImagesOptions

type FindPrivateImagesOptions struct {
	BaseDir            string
	AppSlug            string
	ReplicatedRegistry registry.RegistryOptions
	Installation       *kotsv1beta1.Installation
	AllImagesPrivate   bool
}

type FindPrivateImagesResult

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

func FindPrivateImages

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

type OverlySimpleGVK

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

type OverlySimpleMetadata

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

type RenderOptions

type RenderOptions struct {
	SplitMultiDocYAML      bool
	Namespace              string
	HelmOptions            []string
	LocalRegistryHost      string
	LocalRegistryNamespace string
	LocalRegistryUsername  string
	LocalRegistryPassword  string
	ExcludeKotsKinds       bool
	Log                    *logger.Logger
}

type WriteOptions

type WriteOptions struct {
	BaseDir          string
	Overwrite        bool
	ExcludeKotsKinds bool
}

type WriteUpstreamImageOptions

type WriteUpstreamImageOptions struct {
	BaseDir        string
	AppSlug        string
	SourceRegistry registry.RegistryOptions
	DestRegistry   registry.RegistryOptions
	DryRun         bool
	IsAirgap       bool
	Log            *logger.Logger
	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 CopyUpstreamImages

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