extension

Documentation

Index

• Constants
• Variables
• func Create(p string, config Config) error
• func CreateAppChart(p string, name string, chart []byte) error
• func LoadApplicationClass(name, tempDir string) error
• func PrintTemplate(args []string, o *options.TemplateOptions, out io.Writer) error
• func WithBuiltins(paths []string) error
• func WithHelm(o *options.LintOptions, paths []string) error
• type ApplicationClass
• type Config
• type Extension
  • func Load(path string) (*Extension, error)
  • func LoadFromHelm(path string) (*Extension, error)
  • func (ext *Extension) ToKubernetesResources() []runtimeclient.Object
• type Metadata
  • func LoadMetadata(path string) (*Metadata, error)
  • func (md *Metadata) Init(p string) error
  • func (md *Metadata) LoadIcon(p string) error
  • func (md *Metadata) ToChartYaml() (*chart.Metadata, error)
  • func (md *Metadata) Validate() error

Constants

const MetadataFilename = "extension.yaml"

Variables

var Categories = []string{
	"ai-machine-learning",
	"computing",
	"database",
	"dev-tools",
	"integration-delivery",
	"observability",
	"networking",
	"security",
	"storage",
	"streaming-messaging",
	"other",
}

Functions

func Create

func Create(p string, config Config) error

func CreateAppChart

func CreateAppChart(p string, name string, chart []byte) error

func LoadApplicationClass

func LoadApplicationClass(name, tempDir string) error

func PrintTemplate

func PrintTemplate(args []string, o *options.TemplateOptions, out io.Writer) error

func WithBuiltins

func WithBuiltins(paths []string) error

func WithHelm

func WithHelm(o *options.LintOptions, paths []string) error

Types

type ApplicationClass

type ApplicationClass struct {
	ApplicationClassGroup string               `json:"applicationClassGroup,omitempty"`
	Name                  string               `json:"name,omitempty"`
	Provisioner           string               `json:"provisioner,omitempty"`
	Parameters            map[string]string    `json:"parameters,omitempty"`
	AppVersion            string               `json:"appVersion,omitempty"`
	PackageVersion        string               `json:"packageVersion,omitempty"`
	Icon                  string               `json:"icon,omitempty"`
	Description           corev1alpha1.Locales `json:"description,omitempty"`
	Maintainer            *chart.Maintainer    `json:"maintainer,omitempty"`
}

type Config

type Config struct {
	Name     string
	Category string
	Author   string
	Email    string
	URL      string
}

type Extension

type Extension struct {
	Metadata *Metadata
	// ChartURL valid when the chart source online.
	ChartURL string
	// ChartData valid when the chart source local.
	ChartData []byte
}

func Load

func Load(path string) (*Extension, error)

func LoadFromHelm

func LoadFromHelm(path string) (*Extension, error)

func (*Extension) ToKubernetesResources

func (ext *Extension) ToKubernetesResources() []runtimeclient.Object

type Metadata

type Metadata struct {
	APIVersion string `json:"apiVersion" validate:"required"`
	// The name of the chart. Required.
	Name                 string                                               `json:"name" validate:"required"`
	Version              string                                               `json:"version" validate:"required"`
	DisplayName          corev1alpha1.Locales                                 `json:"displayName" validate:"required"`
	Description          corev1alpha1.Locales                                 `json:"description" validate:"required"`
	Category             string                                               `json:"category" validate:"required"`
	Keywords             []string                                             `json:"keywords,omitempty"`
	Home                 string                                               `json:"home,omitempty"`
	Sources              []string                                             `json:"sources,omitempty"`
	KubeVersion          string                                               `json:"kubeVersion,omitempty"`
	KSVersion            string                                               `json:"ksVersion,omitempty"`
	Maintainers          []*chart.Maintainer                                  `json:"maintainers,omitempty"`
	Provider             map[corev1alpha1.LanguageCode]*corev1alpha1.Provider `json:"provider" validate:"required"`
	Icon                 string                                               `json:"icon" validate:"required"`
	Screenshots          []string                                             `json:"screenshots,omitempty"`
	Dependencies         []*chart.Dependency                                  `json:"dependencies,omitempty"`
	InstallationMode     corev1alpha1.InstallationMode                        `json:"installationMode,omitempty"`
	Namespace            string                                               `json:"namespace,omitempty"`
	Images               []string                                             `json:"images,omitempty"`
	ExternalDependencies []corev1alpha1.ExternalDependency                    `json:"externalDependencies,omitempty"`
}

func LoadMetadata

func LoadMetadata(path string) (*Metadata, error)

func (*Metadata) Init

func (md *Metadata) Init(p string) error

func (*Metadata) LoadIcon

func (md *Metadata) LoadIcon(p string) error

func (*Metadata) ToChartYaml

func (md *Metadata) ToChartYaml() (*chart.Metadata, error)

func (*Metadata) Validate

func (md *Metadata) Validate() error