namespaces

Documentation

Overview

Package namespaces implements namespace lookups and matches for legacy stashcp and osdf-client to maintain backward compatibility.

The namespaces package should not be used for any new features Pelican introduces.

Index

• type Cache
• type CredentialGeneration
• type DirectorCache
• type Namespace
  • func GetNamespaces(ctx context.Context) ([]Namespace, error)
  • func MatchNamespace(ctx context.Context, path string) (Namespace, error)
  • func (ns *Namespace) GetCacheHosts() []string
  • func (ns *Namespace) GetCaches() []Cache
  • func (ns *Namespace) MatchCaches(caches []string) []Cache
• type NamespaceFull

Types

type Cache

type Cache struct {
	AuthEndpoint string `json:"auth_endpoint"`
	Endpoint     string `json:"endpoint"`
	Resource     string `json:"resource"`
}

Cache

type CredentialGeneration

type CredentialGeneration struct {
	Issuer        *string `json:"issuer"`
	BasePath      *string `json:"base_path"`
	MaxScopeDepth *int    `json:"max_scope_depth"`
	Strategy      *string `json:"strategy"`
	VaultServer   *string `json:"vault_server"`
}

Credential generation information

type DirectorCache

type DirectorCache struct {
	ResourceName string
	EndpointUrl  string
	Priority     int
	AuthedReq    bool
}

Cache information from the Director service

type Namespace

type Namespace struct {
	Caches               []Cache `json:"caches"`
	SortedDirectorCaches []DirectorCache
	Path                 string                `json:"path"`
	CredentialGen        *CredentialGeneration `json:"credential_generation"`
	Issuer               []string              `json:"issuer"`
	ReadHTTPS            bool                  `json:"readhttps"`
	UseTokenOnRead       bool                  `json:"usetokenonread"`
	WriteBackHost        string                `json:"writebackhost"`
	DirListHost          string                `json:"dirlisthost"`
}

Namespace holds the structure of stash namespaces

func GetNamespaces

func GetNamespaces(ctx context.Context) ([]Namespace, error)

GetNamespaces returns the list of namespaces

func MatchNamespace

func MatchNamespace(ctx context.Context, path string) (Namespace, error)

MatchNamespace matches the namespace passed in to the namespaces in the list

func (*Namespace) GetCacheHosts

func (ns *Namespace) GetCacheHosts() []string

func (*Namespace) GetCaches

func (ns *Namespace) GetCaches() []Cache

GetCaches returns the list of caches for the namespace

func (*Namespace) MatchCaches

func (ns *Namespace) MatchCaches(caches []string) []Cache

MatchCaches compares the caches passed in (presumably from an ordered list of caches) to the caches for the namespace, and returns the intersection of the two

type NamespaceFull

type NamespaceFull struct {
	Caches     []Cache     `json:"caches"`
	Namespaces []Namespace `json:"namespaces"`
}