api

package
v0.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 13, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package api provides APIs for syncing a chart repository

Index

Constants

This section is empty.

Variables

View Source 
var (
	Kind_name = map[int32]string{
		0: "UNKNOWN",
		1: "HELM",
		2: "CHARTMUSEUM",
		3: "HARBOR",
		4: "OCI",
		5: "LOCAL",
	}
	Kind_value = map[string]int32{
		"UNKNOWN":     0,
		"HELM":        1,
		"CHARTMUSEUM": 2,
		"HARBOR":      3,
		"OCI":         4,
		"LOCAL":       5,
	}
)

Enum value maps for Kind.

View Source 
var File_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Auth 

type Auth struct {
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

Auth contains credentials to login to a chart repository

func (*Auth) Descriptor deprecated 

func (*Auth) Descriptor() ([]byte, []int)

Deprecated: Use Auth.ProtoReflect.Descriptor instead.

func (*Auth) GetPassword 

func (x *Auth) GetPassword() string

func (*Auth) GetUsername 

func (x *Auth) GetUsername() string

func (*Auth) ProtoMessage 

func (*Auth) ProtoMessage()

func (*Auth) ProtoReflect 

func (x *Auth) ProtoReflect() protoreflect.Message

func (*Auth) Reset 

func (x *Auth) Reset()

func (*Auth) String 

func (x *Auth) String() string

type Config 

type Config struct {
	Source *Source `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Target *Target `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"`
	// Helm Charts to include during sync
	Charts []string `protobuf:"bytes,3,rep,name=charts,proto3" json:"charts,omitempty"`
	// Opposite of charts property. It indicates the list of charts to skip during sync
	SkipCharts              []string `protobuf:"bytes,5,rep,name=skip_charts,json=skipCharts,proto3" json:"skip_charts,omitempty"`
	RelocateContainerImages bool     `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Config file structure

func (*Config) Descriptor deprecated 

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetCharts added in v0.6.0 

func (x *Config) GetCharts() []string

func (*Config) GetRelocateContainerImages added in v0.11.0 

func (x *Config) GetRelocateContainerImages() bool

func (*Config) GetSkipCharts added in v0.14.0 

func (x *Config) GetSkipCharts() []string

func (*Config) GetSource 

func (x *Config) GetSource() *Source

func (*Config) GetTarget 

func (x *Config) GetTarget() *Target

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) ProtoReflect 

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) String 

func (x *Config) String() string

func (*Config) Validate 

func (c *Config) Validate() error

Validate validates the config file is correct

type Containers added in v0.13.0 

type Containers struct {
	Auth *Containers_ContainerAuth `protobuf:"bytes,1,opt,name=auth,proto3" json:"auth,omitempty"`
	// contains filtered or unexported fields
}

func (*Containers) Descriptor deprecated added in v0.13.0 

func (*Containers) Descriptor() ([]byte, []int)

Deprecated: Use Containers.ProtoReflect.Descriptor instead.

func (*Containers) GetAuth added in v0.13.0 

func (x *Containers) GetAuth() *Containers_ContainerAuth

func (*Containers) ProtoMessage added in v0.13.0 

func (*Containers) ProtoMessage()

func (*Containers) ProtoReflect added in v0.13.0 

func (x *Containers) ProtoReflect() protoreflect.Message

func (*Containers) Reset added in v0.13.0 

func (x *Containers) Reset()

func (*Containers) String added in v0.13.0 

func (x *Containers) String() string

type Containers_ContainerAuth added in v0.13.0 

type Containers_ContainerAuth struct {
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	Registry string `protobuf:"bytes,3,opt,name=registry,proto3" json:"registry,omitempty"`
	// contains filtered or unexported fields
}

ContainerAuth defines the authentication parameters required to access the source/target OCI registries during container image relocation

func (*Containers_ContainerAuth) Descriptor deprecated added in v0.13.0 

func (*Containers_ContainerAuth) Descriptor() ([]byte, []int)

Deprecated: Use Containers_ContainerAuth.ProtoReflect.Descriptor instead.

func (*Containers_ContainerAuth) GetPassword added in v0.13.0 

func (x *Containers_ContainerAuth) GetPassword() string

func (*Containers_ContainerAuth) GetRegistry added in v0.13.0 

func (x *Containers_ContainerAuth) GetRegistry() string

func (*Containers_ContainerAuth) GetUsername added in v0.13.0 

func (x *Containers_ContainerAuth) GetUsername() string

func (*Containers_ContainerAuth) ProtoMessage added in v0.13.0 

func (*Containers_ContainerAuth) ProtoMessage()

func (*Containers_ContainerAuth) ProtoReflect added in v0.13.0 

func (x *Containers_ContainerAuth) ProtoReflect() protoreflect.Message

func (*Containers_ContainerAuth) Reset added in v0.13.0 

func (x *Containers_ContainerAuth) Reset()

func (*Containers_ContainerAuth) String added in v0.13.0 

func (x *Containers_ContainerAuth) String() string

type Kind 

type Kind int32
const (
	Kind_UNKNOWN     Kind = 0
	Kind_HELM        Kind = 1
	Kind_CHARTMUSEUM Kind = 2
	Kind_HARBOR      Kind = 3
	Kind_OCI         Kind = 4
	Kind_LOCAL       Kind = 5
)

func (Kind) Descriptor 

func (Kind) Descriptor() protoreflect.EnumDescriptor

func (Kind) Enum 

func (x Kind) Enum() *Kind

func (Kind) EnumDescriptor deprecated 

func (Kind) EnumDescriptor() ([]byte, []int)

Deprecated: Use Kind.Descriptor instead.

func (Kind) Number 

func (x Kind) Number() protoreflect.EnumNumber

func (Kind) String 

func (x Kind) String() string

func (Kind) Type 

func (Kind) Type() protoreflect.EnumType

type Repo 

type Repo struct {
	Url  string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	Kind Kind   `protobuf:"varint,2,opt,name=kind,proto3,enum=api.Kind" json:"kind,omitempty"`
	Auth *Auth  `protobuf:"bytes,3,opt,name=auth,proto3" json:"auth,omitempty"`
	// The path where the repo stores charts. Useful for LOCAL kind only
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// The OCI reference where the index of charts is located
	// Example: my.oci.domain/index:latest
	ChartsIndex string `protobuf:"bytes,5,opt,name=charts_index,json=chartsIndex,proto3" json:"charts_index,omitempty"`
	// Whether to use a charts index to find charts
	//
	// Deprecated: Do not use.
	UseChartsIndex     bool `protobuf:"varint,6,opt,name=use_charts_index,json=useChartsIndex,proto3" json:"use_charts_index,omitempty"`
	DisableChartsIndex bool `protobuf:"varint,7,opt,name=disable_charts_index,json=disableChartsIndex,proto3" json:"disable_charts_index,omitempty"`
	// contains filtered or unexported fields
}

Generic repo representation

func (*Repo) Descriptor deprecated 

func (*Repo) Descriptor() ([]byte, []int)

Deprecated: Use Repo.ProtoReflect.Descriptor instead.

func (*Repo) GetAuth 

func (x *Repo) GetAuth() *Auth

func (*Repo) GetChartsIndex added in v0.10.0 

func (x *Repo) GetChartsIndex() string

func (*Repo) GetDisableChartsIndex added in v0.13.0 

func (x *Repo) GetDisableChartsIndex() bool

func (*Repo) GetKind 

func (x *Repo) GetKind() Kind

func (*Repo) GetPath added in v0.6.2 

func (x *Repo) GetPath() string

func (*Repo) GetUrl 

func (x *Repo) GetUrl() string

func (*Repo) GetUseChartsIndex deprecated added in v0.12.0 

func (x *Repo) GetUseChartsIndex() bool

Deprecated: Do not use.

func (*Repo) ProtoMessage 

func (*Repo) ProtoMessage()

func (*Repo) ProtoReflect 

func (x *Repo) ProtoReflect() protoreflect.Message

func (*Repo) Reset 

func (x *Repo) Reset()

func (*Repo) String 

func (x *Repo) String() string

type Source added in v0.12.0 

type Source struct {

	// Types that are assignable to Spec:
	//	*Source_Repo
	//	*Source_IntermediateBundlesPath
	Spec isSource_Spec `protobuf_oneof:"spec"`
	// Ignored if the repo is an intermediate bundle since the images are inside the bundle
	Containers *Containers `protobuf:"bytes,3,opt,name=containers,proto3" json:"containers,omitempty"`
	// contains filtered or unexported fields
}

SourceRepo contains the required information of the source chart repository

func (*Source) Descriptor deprecated added in v0.12.0 

func (*Source) Descriptor() ([]byte, []int)

Deprecated: Use Source.ProtoReflect.Descriptor instead.

func (*Source) GetContainers added in v0.13.0 

func (x *Source) GetContainers() *Containers

func (*Source) GetIntermediateBundlesPath added in v0.12.0 

func (x *Source) GetIntermediateBundlesPath() string

func (*Source) GetRepo added in v0.12.0 

func (x *Source) GetRepo() *Repo

func (*Source) GetSpec added in v0.12.0 

func (m *Source) GetSpec() isSource_Spec

func (*Source) ProtoMessage added in v0.12.0 

func (*Source) ProtoMessage()

func (*Source) ProtoReflect added in v0.12.0 

func (x *Source) ProtoReflect() protoreflect.Message

func (*Source) Reset added in v0.12.0 

func (x *Source) Reset()

func (*Source) String added in v0.12.0 

func (x *Source) String() string

type Source_IntermediateBundlesPath added in v0.12.0 

type Source_IntermediateBundlesPath struct {
	IntermediateBundlesPath string `protobuf:"bytes,2,opt,name=intermediate_bundles_path,json=intermediateBundlesPath,proto3,oneof"`
}

type Source_Repo added in v0.12.0 

type Source_Repo struct {
	Repo *Repo `protobuf:"bytes,1,opt,name=repo,proto3,oneof"`
}

type Target added in v0.12.0 

type Target struct {

	// Types that are assignable to Spec:
	//	*Target_Repo
	//	*Target_IntermediateBundlesPath
	Spec                isTarget_Spec `protobuf_oneof:"spec"`
	ContainerRegistry   string        `protobuf:"bytes,2,opt,name=container_registry,json=containerRegistry,proto3" json:"container_registry,omitempty"`
	ContainerRepository string        `protobuf:"bytes,3,opt,name=container_repository,json=containerRepository,proto3" json:"container_repository,omitempty"`
	RepoName            string        `protobuf:"bytes,4,opt,name=repo_name,json=repoName,proto3" json:"repo_name,omitempty"`
	Containers          *Containers   `protobuf:"bytes,6,opt,name=containers,proto3" json:"containers,omitempty"`
	// contains filtered or unexported fields
}

TargetRepo contains the required information of the target chart repository

func (*Target) Descriptor deprecated added in v0.12.0 

func (*Target) Descriptor() ([]byte, []int)

Deprecated: Use Target.ProtoReflect.Descriptor instead.

func (*Target) GetContainerRegistry added in v0.12.0 

func (x *Target) GetContainerRegistry() string

func (*Target) GetContainerRepository added in v0.12.0 

func (x *Target) GetContainerRepository() string

func (*Target) GetContainers added in v0.13.0 

func (x *Target) GetContainers() *Containers

func (*Target) GetIntermediateBundlesPath added in v0.12.0 

func (x *Target) GetIntermediateBundlesPath() string

func (*Target) GetRepo added in v0.12.0 

func (x *Target) GetRepo() *Repo

func (*Target) GetRepoName added in v0.12.0 

func (x *Target) GetRepoName() string

func (*Target) GetSpec added in v0.12.0 

func (m *Target) GetSpec() isTarget_Spec

func (*Target) ProtoMessage added in v0.12.0 

func (*Target) ProtoMessage()

func (*Target) ProtoReflect added in v0.12.0 

func (x *Target) ProtoReflect() protoreflect.Message

func (*Target) Reset added in v0.12.0 

func (x *Target) Reset()

func (*Target) String added in v0.12.0 

func (x *Target) String() string

type Target_IntermediateBundlesPath added in v0.12.0 

type Target_IntermediateBundlesPath struct {
	IntermediateBundlesPath string `protobuf:"bytes,5,opt,name=intermediate_bundles_path,json=intermediateBundlesPath,proto3,oneof"`
}

type Target_Repo added in v0.12.0 

type Target_Repo struct {
	Repo *Repo `protobuf:"bytes,1,opt,name=repo,proto3,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.