carvel

Documentation

Overview

Package carvel implements experimental Carvel support

Index

• Constants
• func CreateImagesLock(lock *imagelock.ImagesLock) (lockconfig.ImagesLock, error)
• type Author
• type BundleVersion
• type Metadata
  • func CreateBundleMetadata(chartPath string, lock *imagelock.ImagesLock, cfg *chartutils.Configuration) (*Metadata, error)
  • func NewCarvelBundle() *Metadata
  • func (il *Metadata) ToYAML(w io.Writer) error
• type Website

Constants

const (
	BundleAPIVersion = "imgpkg.carvel.dev/v1alpha1"
	BundleKind       = "Bundle"
)

Bundle Metadata

const CarvelBundleFilePath = ".imgpkg/bundle.yml"

CarvelBundleFilePath represents the usual bundle file for Carvel packaging

const CarvelImagesFilePath = ".imgpkg/images.yml"

CarvelImagesFilePath represents the usual images file for Carvel packaging

Functions

func CreateImagesLock

func CreateImagesLock(lock *imagelock.ImagesLock) (lockconfig.ImagesLock, error)

CreateImagesLock builds and set a new Carvel images lock struct

Types

type Author

type Author struct {
	Name  string `json:"name,omitempty"`
	Email string `json:"email,omitempty"`
}

Author information from a Bundle

type BundleVersion

type BundleVersion struct {
	APIVersion string `json:"apiVersion"` // This generated yaml, but due to lib we need to use `json`
	Kind       string `json:"kind"`       // This generated yaml, but due to lib we need to use `json`
}

BundleVersion with detailsa bout the Carvel bundle version

type Metadata

type Metadata struct {
	Version  BundleVersion
	Metadata map[string]string `json:"metadata,omitempty"`
	Authors  []Author          `json:"authors,omitempty"`
	Websites []Website         `json:"websites,omitempty"`
}

Metadata for a Carvel bundle

func CreateBundleMetadata

func CreateBundleMetadata(chartPath string, lock *imagelock.ImagesLock, cfg *chartutils.Configuration) (*Metadata, error)

CreateBundleMetadata builds and sets a new Carvel bundle struct

func NewCarvelBundle

func NewCarvelBundle() *Metadata

NewCarvelBundle returns a new carvel bundle Metadata instance

func (*Metadata) ToYAML

func (il *Metadata) ToYAML(w io.Writer) error

ToYAML serializes the Carvel bundle into YAML

type Website

type Website struct {
	URL string `json:"url,omitempty"`
}

Website URL where more information of the Bundle can be found