catalog

Documentation

Index

• Constants
• func NewCatalogClient(ctx context.Context, authOpt ...grpc.DialOption) (catalog.Client, error)
• type Config
  • func GetConfig() *Config
  • func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet
• type DiscoveryType
• type NOOPCatalog
  • func (n NOOPCatalog) Get(_ context.Context, _ catalog.Key) (catalog.Entry, error)
  • func (n NOOPCatalog) GetOrExtendReservation(_ context.Context, _ catalog.Key, _ string, _ time.Duration) (*datacatalog.Reservation, error)
  • func (n NOOPCatalog) Put(_ context.Context, _ catalog.Key, _ io.OutputReader, _ catalog.Metadata) (catalog.Status, error)
  • func (n NOOPCatalog) ReleaseReservation(_ context.Context, _ catalog.Key, _ string) error
  • func (n NOOPCatalog) Update(_ context.Context, _ catalog.Key, _ io.OutputReader, _ catalog.Metadata) (catalog.Status, error)

Constants

const ConfigSectionKey = "catalog-cache"

Functions

func NewCatalogClient

func NewCatalogClient(ctx context.Context, authOpt ...grpc.DialOption) (catalog.Client, error)

Types

type Config

type Config struct {
	Type         DiscoveryType   `json:"type" pflag:"\"noop\", Catalog Implementation to use"`
	Endpoint     string          `json:"endpoint" pflag:"\"\", Endpoint for catalog service"`
	Insecure     bool            `json:"insecure" pflag:"false, Use insecure grpc connection"`
	MaxCacheAge  config.Duration `json:"max-cache-age" pflag:", Cache entries past this age will incur cache miss. 0 means cache never expires"`
	UseAdminAuth bool            `json:"use-admin-auth" pflag:"false, Use the same gRPC credentials option as the flyteadmin client"`

	// Set the gRPC service config formatted as a json string https://github.com/grpc/grpc/blob/master/doc/service_config.md
	// eg. {"loadBalancingConfig": [{"round_robin":{}}], "methodConfig": [{"name":[{"service": "foo", "method": "bar"}, {"service": "baz"}], "timeout": "1.000000001s"}]}
	// find the full schema here https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto#L625
	// Note that required packages may need to be preloaded to support certain service config. For example "google.golang.org/grpc/balancer/roundrobin" should be preloaded to have round-robin policy supported.
	DefaultServiceConfig string `json:"default-service-config" pflag:"\"\", Set the default service config for the catalog gRPC client"`
}

func GetConfig

func GetConfig() *Config

GetConfig gets loaded config for Discovery

func (Config) GetPFlagSet

func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet

GetPFlagSet will return strongly types pflags for all fields in Config and its nested types. The format of the flags is json-name.json-sub-name... etc.

type DiscoveryType

type DiscoveryType = string

const (
	NoOpDiscoveryType DiscoveryType = "noop"
	DataCatalogType   DiscoveryType = "datacatalog"
)

type NOOPCatalog

type NOOPCatalog struct {
}

func (NOOPCatalog) Get

func (n NOOPCatalog) Get(_ context.Context, _ catalog.Key) (catalog.Entry, error)

func (NOOPCatalog) GetOrExtendReservation

func (n NOOPCatalog) GetOrExtendReservation(_ context.Context, _ catalog.Key, _ string, _ time.Duration) (*datacatalog.Reservation, error)

func (NOOPCatalog) Put

func (n NOOPCatalog) Put(_ context.Context, _ catalog.Key, _ io.OutputReader, _ catalog.Metadata) (catalog.Status, error)

func (NOOPCatalog) ReleaseReservation

func (n NOOPCatalog) ReleaseReservation(_ context.Context, _ catalog.Key, _ string) error

func (NOOPCatalog) Update

func (n NOOPCatalog) Update(_ context.Context, _ catalog.Key, _ io.OutputReader, _ catalog.Metadata) (catalog.Status, error)