cmd

Documentation

Overview

Package cmd provides commands for package tooling

Index

• func Execute()
• type CarvelTools
• type Deploy
• type Package
• type PackageSpec
• type PackageValues
• type Repository
• type Tool

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type CarvelTools

type CarvelTools struct {
	Tools []Tool `yaml:"tools"`
}

CarvelTools defines the carvel tools used for building packages

type Deploy

type Deploy struct {
	KappWaitTimeout string `yaml:"kappWaitTimeout"`
	KubeAPIQPS      string `yaml:"kubeAPIQPS"`
	KubeAPIBurst    string `yaml:"kubeAPIBurst"`
}

Deploy defines package deployment configuration

type Package

type Package struct {
	Name                string            `yaml:"name"`
	DisplayName         string            `yaml:"displayName"`
	Path                string            `yaml:"path"`
	Domain              string            `yaml:"domain"`
	Version             string            `yaml:"version"`
	Sha256              string            `yaml:"sha256"`
	PackageSubVersion   string            `yaml:"packageSubVersion,omitempty"`
	SkipVersionOverride bool              `yaml:"skipVersionOverride,omitempty"`
	Env                 map[string]string `yaml:"env,omitempty"`
}

Package holds the information about a package

type PackageSpec

type PackageSpec struct {
	SyncPeriod string `yaml:"syncPeriod"`
	Deploy     Deploy `yaml:"deploy"`
}

PackageSpec defines a particular package configuration

type PackageValues

type PackageValues struct {
	Repositories map[string]Repository `yaml:"repositories"`
}

PackageValues defines the packages configuration

type Repository

type Repository struct {
	Name        string      `yaml:"name"`
	Domain      string      `yaml:"domain"`
	PackageSpec PackageSpec `yaml:"packageSpec"`
	Packages    []Package   `yaml:"packages"`
	Sha256      string      `yaml:"sha256"`
	Registry    string      `yaml:"registry"`
}

Repository defines package repository configuration

type Tool

type Tool struct {
	Name    string `yaml:"name"`
	Version string `yaml:"version"`
	URL     string `yaml:"url"`
}

Tool is the definition of the carvel tool