tkgpackagedatamodel

Documentation

Overview

nolint

Index

• Constants
• type ImagePullSecretOptions
  • func NewImagePullSecretOptions() *ImagePullSecretOptions
• type PackageAvailableOptions
  • func NewPackageAvailableOptions() *PackageAvailableOptions
• type PackageOptions
  • func NewPackageOptions() *PackageOptions
• type PackagePluginNonCriticalError
  • func (e *PackagePluginNonCriticalError) Error() string
• type PackageProgress
• type RepositoryOptions
  • func NewRepositoryOptions() *RepositoryOptions

Constants

const (
	ClusterRoleBindingName     = "%s-%s-cluster-rolebinding"
	ClusterRoleName            = "%s-%s-cluster-role"
	DefaultAPIVersion          = "install.package.carvel.dev/v1alpha1"
	DefaultPollInterval        = 1 * time.Second
	DefaultPollTimeout         = 5 * time.Minute
	ErrPackageAlreadyInstalled = "package install already exists in the namespace"
	ErrPackageNotInstalled     = "package install does not exist in the namespace"
	KindClusterRole            = "ClusterRole"
	KindClusterRoleBinding     = "ClusterRoleBinding"
	KindNamespace              = "Namespace"
	KindPackageInstall         = "PackageInstall"
	KindPackageRepository      = "PackageRepository"
	KindSecret                 = "Secret"
	KindSecretExport           = "SecretExport"
	KindServiceAccount         = "ServiceAccount"
	SecretName                 = "%s-%s-values"
	ServiceAccountName         = "%s-%s-sa"
	ShortDescriptionMaxLength  = 20
	TanzuPkgPluginAnnotation   = "tkg.tanzu.vmware.com/tanzu-package"
	TanzuPkgPluginPrefix       = "tanzu-package"
	TanzuPkgPluginResource     = "%s-%s"
	YamlSeparator              = "---"
)

Types

type ImagePullSecretOptions

type ImagePullSecretOptions struct {
	AllNamespaces         bool
	ExportToAllNamespaces bool
	PasswordStdin         bool
	SkipPrompt            bool
	KubeConfig            string
	Namespace             string
	Password              string
	PasswordEnvVar        string
	PasswordFile          string
	PasswordInput         string
	Registry              string
	SecretName            string
	Username              string
}

ImagePullSecretOptions includes fields for image pull secret operations

func NewImagePullSecretOptions

func NewImagePullSecretOptions() *ImagePullSecretOptions

NewImagePullSecretOptions instantiates ImagePullSecretOptions

type PackageAvailableOptions

type PackageAvailableOptions struct {
	KubeConfig    string
	Namespace     string
	PackageName   string
	AllNamespaces bool
	ValuesSchema  bool
}

PackageAvailableOptions includes fields for package available

func NewPackageAvailableOptions

func NewPackageAvailableOptions() *PackageAvailableOptions

NewPackageAvailableOptions instantiates PackageAvailableOptions

type PackageOptions

type PackageOptions struct {
	Available              string
	ClusterRoleName        string
	ClusterRoleBindingName string
	KubeConfig             string
	Namespace              string
	PackageName            string
	PkgInstallName         string
	SecretName             string
	ServiceAccountName     string
	ValuesFile             string
	Version                string
	PollInterval           time.Duration
	PollTimeout            time.Duration
	AllNamespaces          bool
	CreateNamespace        bool
	Install                bool
	Wait                   bool
	SkipPrompt             bool
}

PackageOptions includes fields for package operations

func NewPackageOptions

func NewPackageOptions() *PackageOptions

NewPackageOptions instantiates PackageOptions

type PackagePluginNonCriticalError

type PackagePluginNonCriticalError struct {
	Reason string
}

PackagePluginNonCriticalError is used for non critical package plugin errors which should be treated more like warnings

func (*PackagePluginNonCriticalError) Error

func (e *PackagePluginNonCriticalError) Error() string

type PackageProgress

type PackageProgress struct {
	// Use buffered chan so that sending goroutine doesn't block
	ProgressMsg chan string
	// Err chan for reporting errors
	Err chan error
	// Empty struct for signaling that goroutine is finished
	Done chan struct{}
}

PackageProgress includes channels for sending messages

type RepositoryOptions

type RepositoryOptions struct {
	KubeConfig       string
	Namespace        string
	RepositoryName   string
	RepositoryURL    string
	AllNamespaces    bool
	CreateRepository bool
	CreateNamespace  bool
	IsForceDelete    bool
}

RepositoryOptions includes fields for repository operations

func NewRepositoryOptions

func NewRepositoryOptions() *RepositoryOptions

NewRepositoryOptions instantiates RepositoryOptions