Documentation ¶
Overview ¶
Package api provides APIs for syncing a chart repository
Index ¶
- Variables
- type Auth
- type Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- func (x *Config) GetCharts() []string
- func (x *Config) GetRelocateContainerImages() bool
- func (x *Config) GetSkipCharts() []string
- func (x *Config) GetSource() *Source
- func (x *Config) GetTarget() *Target
- func (*Config) ProtoMessage()
- func (x *Config) ProtoReflect() protoreflect.Message
- func (x *Config) Reset()
- func (x *Config) String() string
- func (c *Config) Validate() error
- type Containers
- type Containers_ContainerAuth
- func (*Containers_ContainerAuth) Descriptor() ([]byte, []int)deprecated
- func (x *Containers_ContainerAuth) GetPassword() string
- func (x *Containers_ContainerAuth) GetRegistry() string
- func (x *Containers_ContainerAuth) GetUsername() string
- func (*Containers_ContainerAuth) ProtoMessage()
- func (x *Containers_ContainerAuth) ProtoReflect() protoreflect.Message
- func (x *Containers_ContainerAuth) Reset()
- func (x *Containers_ContainerAuth) String() string
- type Kind
- type Repo
- func (*Repo) Descriptor() ([]byte, []int)deprecated
- func (x *Repo) GetAuth() *Auth
- func (x *Repo) GetChartsIndex() string
- func (x *Repo) GetDisableChartsIndex() bool
- func (x *Repo) GetKind() Kind
- func (x *Repo) GetPath() string
- func (x *Repo) GetUrl() string
- func (x *Repo) GetUseChartsIndex() booldeprecated
- func (*Repo) ProtoMessage()
- func (x *Repo) ProtoReflect() protoreflect.Message
- func (x *Repo) Reset()
- func (x *Repo) String() string
- type Source
- func (*Source) Descriptor() ([]byte, []int)deprecated
- func (x *Source) GetContainers() *Containers
- func (x *Source) GetIntermediateBundlesPath() string
- func (x *Source) GetRepo() *Repo
- func (m *Source) GetSpec() isSource_Spec
- func (*Source) ProtoMessage()
- func (x *Source) ProtoReflect() protoreflect.Message
- func (x *Source) Reset()
- func (x *Source) String() string
- type Source_IntermediateBundlesPath
- type Source_Repo
- type Target
- func (*Target) Descriptor() ([]byte, []int)deprecated
- func (x *Target) GetContainerRegistry() string
- func (x *Target) GetContainerRepository() string
- func (x *Target) GetContainers() *Containers
- func (x *Target) GetIntermediateBundlesPath() string
- func (x *Target) GetRepo() *Repo
- func (x *Target) GetRepoName() string
- func (m *Target) GetSpec() isTarget_Spec
- func (*Target) ProtoMessage()
- func (x *Target) ProtoReflect() protoreflect.Message
- func (x *Target) Reset()
- func (x *Target) String() string
- type Target_IntermediateBundlesPath
- type Target_Repo
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) GetPassword ¶
func (*Auth) GetUsername ¶
func (*Auth) ProtoMessage ¶
func (*Auth) ProtoMessage()
func (*Auth) ProtoReflect ¶
func (x *Auth) ProtoReflect() protoreflect.Message
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) GetRelocateContainerImages ¶
func (*Config) GetSkipCharts ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶
func (x *Config) ProtoReflect() protoreflect.Message
type Containers ¶
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
func (*Containers) Descriptor() ([]byte, []int)
Deprecated: Use Containers.ProtoReflect.Descriptor instead.
func (*Containers) GetAuth ¶
func (x *Containers) GetAuth() *Containers_ContainerAuth
func (*Containers) ProtoMessage ¶
func (*Containers) ProtoMessage()
func (*Containers) ProtoReflect ¶
func (x *Containers) ProtoReflect() protoreflect.Message
func (*Containers) Reset ¶
func (x *Containers) Reset()
func (*Containers) String ¶
func (x *Containers) String() string
type Containers_ContainerAuth ¶
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
func (*Containers_ContainerAuth) Descriptor() ([]byte, []int)
Deprecated: Use Containers_ContainerAuth.ProtoReflect.Descriptor instead.
func (*Containers_ContainerAuth) GetPassword ¶
func (x *Containers_ContainerAuth) GetPassword() string
func (*Containers_ContainerAuth) GetRegistry ¶
func (x *Containers_ContainerAuth) GetRegistry() string
func (*Containers_ContainerAuth) GetUsername ¶
func (x *Containers_ContainerAuth) GetUsername() string
func (*Containers_ContainerAuth) ProtoMessage ¶
func (*Containers_ContainerAuth) ProtoMessage()
func (*Containers_ContainerAuth) ProtoReflect ¶
func (x *Containers_ContainerAuth) ProtoReflect() protoreflect.Message
func (*Containers_ContainerAuth) Reset ¶
func (x *Containers_ContainerAuth) Reset()
func (*Containers_ContainerAuth) String ¶
func (x *Containers_ContainerAuth) String() string
type Kind ¶
type Kind int32
func (Kind) Descriptor ¶
func (Kind) Descriptor() protoreflect.EnumDescriptor
func (Kind) EnumDescriptor
deprecated
func (Kind) Number ¶
func (x Kind) Number() protoreflect.EnumNumber
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) GetChartsIndex ¶
func (*Repo) GetDisableChartsIndex ¶
func (*Repo) GetUseChartsIndex
deprecated
func (*Repo) ProtoMessage ¶
func (*Repo) ProtoMessage()
func (*Repo) ProtoReflect ¶
func (x *Repo) ProtoReflect() protoreflect.Message
type Source ¶
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
func (*Source) GetContainers ¶
func (x *Source) GetContainers() *Containers
func (*Source) GetIntermediateBundlesPath ¶
func (*Source) ProtoMessage ¶
func (*Source) ProtoMessage()
func (*Source) ProtoReflect ¶
func (x *Source) ProtoReflect() protoreflect.Message
type Source_IntermediateBundlesPath ¶
type Source_IntermediateBundlesPath struct {
IntermediateBundlesPath string `protobuf:"bytes,2,opt,name=intermediate_bundles_path,json=intermediateBundlesPath,proto3,oneof"`
}
type Source_Repo ¶
type Source_Repo struct {
Repo *Repo `protobuf:"bytes,1,opt,name=repo,proto3,oneof"`
}
type Target ¶
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
func (*Target) GetContainerRegistry ¶
func (*Target) GetContainerRepository ¶
func (*Target) GetContainers ¶
func (x *Target) GetContainers() *Containers
func (*Target) GetIntermediateBundlesPath ¶
func (*Target) GetRepoName ¶
func (*Target) ProtoMessage ¶
func (*Target) ProtoMessage()
func (*Target) ProtoReflect ¶
func (x *Target) ProtoReflect() protoreflect.Message
type Target_IntermediateBundlesPath ¶
type Target_IntermediateBundlesPath struct {
IntermediateBundlesPath string `protobuf:"bytes,5,opt,name=intermediate_bundles_path,json=intermediateBundlesPath,proto3,oneof"`
}
type Target_Repo ¶
type Target_Repo struct {
Repo *Repo `protobuf:"bytes,1,opt,name=repo,proto3,oneof"`
}
Click to show internal directories.
Click to hide internal directories.