xrootd

Documentation

Index

• func CheckCacheXrootdEnv(exportPath string, server server_structs.XRootDServer, uid int, gid int) (string, error)
• func CheckOriginXrootdEnv(exportPath string, server server_structs.XRootDServer, uid int, gid int, ...) error
• func CheckXrootdEnv(server server_structs.XRootDServer) error
• func ConfigXrootd(ctx context.Context, origin bool) (string, error)
• func ConfigureLaunchers(privileged bool, configPath string, useCMSD bool, enableCache bool) (launchers []daemon.Launcher, err error)
• func CopyXrootdCertificates(server server_structs.XRootDServer) error
• func EmitAuthfile(server server_structs.XRootDServer) error
• func EmitIssuerMetadata(exportPath string, xServeUrl string) error
• func EmitScitokensConfig(server server_structs.XRootDServer) error
• func LaunchDaemons(ctx context.Context, launchers []daemon.Launcher, egrp *errgroup.Group, ...) (pids []int, err error)
• func LaunchXrootdMaintenance(ctx context.Context, server server_structs.XRootDServer, ...)
• func ScanLinesWithCont(data []byte, atEOF bool) (advance int, token []byte, err error)
• func SetUpMonitoring(ctx context.Context, egrp *errgroup.Group) error
• func WriteCacheScitokensConfig(nsAds []server_structs.NamespaceAdV2) error
• func WriteOriginScitokensConfig(exportedPaths []string) error
• type CacheConfig
• type GlobalCfg
• type Issuer
  • func GenerateDirectorMonitoringIssuer() (issuer Issuer, err error)
  • func GenerateMonitoringIssuer() (issuer Issuer, err error)
  • func GenerateOriginIssuer(exportedPaths []string) (issuer Issuer, err error)
• type LoggingConfig
• type OriginConfig
• type PrivilegedXrootdLauncher
  • func (plauncher PrivilegedXrootdLauncher) Launch(ctx context.Context) (context.Context, int, error)
  • func (launcher PrivilegedXrootdLauncher) Name() string
• type ScitokensCfg
  • func LoadScitokensConfig(fileName string) (cfg ScitokensCfg, err error)
• type ServerConfig
• type UnprivilegedXrootdLauncher
• type XrootdConfig
• type XrootdOptions

Functions

func CheckCacheXrootdEnv

func CheckCacheXrootdEnv(exportPath string, server server_structs.XRootDServer, uid int, gid int) (string, error)

func CheckOriginXrootdEnv

func CheckOriginXrootdEnv(exportPath string, server server_structs.XRootDServer, uid int, gid int, groupname string) error

CheckOriginXrootdEnv is almost a misnomer -- it does both checking and configuring. In partcicular, it is responsible for setting up the exports and handling all the symlinking we use to export our directories.

func CheckXrootdEnv

func CheckXrootdEnv(server server_structs.XRootDServer) error

func ConfigXrootd

func ConfigXrootd(ctx context.Context, origin bool) (string, error)

func ConfigureLaunchers

func ConfigureLaunchers(privileged bool, configPath string, useCMSD bool, enableCache bool) (launchers []daemon.Launcher, err error)

func CopyXrootdCertificates

func CopyXrootdCertificates(server server_structs.XRootDServer) error

Copies the server certificate/key files into the XRootD runtime directory. Combines the two files into a single one so the new certificate shows up atomically from XRootD's perspective. Adjusts the ownership and mode to match that expected by the XRootD framework.

func EmitAuthfile

func EmitAuthfile(server server_structs.XRootDServer) error

Parse the input xrootd authfile, add any default configurations, and then save it into the xrootd runtime directory

func EmitIssuerMetadata

func EmitIssuerMetadata(exportPath string, xServeUrl string) error

func EmitScitokensConfig

func EmitScitokensConfig(server server_structs.XRootDServer) error

Writes out the server's scitokens.cfg configuration

func LaunchDaemons

func LaunchDaemons(ctx context.Context, launchers []daemon.Launcher, egrp *errgroup.Group, portStartCallback func(int)) (pids []int, err error)

func LaunchXrootdMaintenance

func LaunchXrootdMaintenance(ctx context.Context, server server_structs.XRootDServer, sleepTime time.Duration)

Launch a separate goroutine that performs the XRootD maintenance tasks. For maintenance that is periodic, `sleepTime` is the maintenance period.

func ScanLinesWithCont

func ScanLinesWithCont(data []byte, atEOF bool) (advance int, token []byte, err error)

Scan through the lines of a file, respecting line continuation characters. That is,

``` foo \ bar ```

Would be parsed as a single line, `foo bar`.

Follows the ScanFunc interface defined by bufio.

func SetUpMonitoring

func SetUpMonitoring(ctx context.Context, egrp *errgroup.Group) error

Set up xrootd monitoring

The `ctx` is the context for listening to server shutdown event in order to cleanup internal cache eviction goroutine and `wg` is the wait group to notify when the clean up goroutine finishes

func WriteCacheScitokensConfig

func WriteCacheScitokensConfig(nsAds []server_structs.NamespaceAdV2) error

Writes out the cache's scitokens.cfg configuration

func WriteOriginScitokensConfig

func WriteOriginScitokensConfig(exportedPaths []string) error

Writes out the origin's scitokens.cfg configuration

Types

type CacheConfig

type CacheConfig struct {
	UseCmsd        bool
	EnableVoms     bool
	CalculatedPort string
	HighWaterMark  string
	LowWatermark   string
	ExportLocation string
	RunLocation    string
	DataLocation   string
	PSSOrigin      string
	Concurrency    int
}

type GlobalCfg

type GlobalCfg struct {
	Audience []string
}

XRootD server-wide configurations for SciTokens.

type Issuer

type Issuer struct {
	Name            string
	Issuer          string
	BasePaths       []string
	RestrictedPaths []string
	MapSubject      bool
	DefaultUser     string
	UsernameClaim   string
	NameMapfile     string
}

Per-issuer configuration

func GenerateDirectorMonitoringIssuer

func GenerateDirectorMonitoringIssuer() (issuer Issuer, err error)

We have a special issuer just for director-based monitoring of the origin.

func GenerateMonitoringIssuer

func GenerateMonitoringIssuer() (issuer Issuer, err error)

We have a special issuer just for self-monitoring the origin.

func GenerateOriginIssuer

func GenerateOriginIssuer(exportedPaths []string) (issuer Issuer, err error)

type LoggingConfig

type LoggingConfig struct {
	OriginCms       string
	OriginHttp      string
	OriginOfs       string
	OriginOss       string
	OriginScitokens string
	OriginXrd       string
	OriginXrootd    string
	CacheHttp       string
	CacheOfs        string
	CachePfc        string
	CachePss        string
	PssSetOptCache  string
	CacheScitokens  string
	CacheXrd        string
	CacheXrootd     string
}

type OriginConfig

type OriginConfig struct {
	Multiuser         bool
	EnableCmsd        bool
	EnableMacaroons   bool
	EnableVoms        bool
	EnablePublicReads bool
	EnableListings    bool
	SelfTest          bool
	CalculatedPort    string
	FederationPrefix  string
	HttpServiceUrl    string
	RunLocation       string
	StorageType       string

	// S3 specific options that are kept top-level because
	// they aren't specific to each export
	S3Region     string
	S3ServiceUrl string
	S3UrlStyle   string
	Exports      []server_utils.OriginExport
}

type PrivilegedXrootdLauncher

type PrivilegedXrootdLauncher struct {
	// contains filtered or unexported fields
}

func (PrivilegedXrootdLauncher) Launch

func (plauncher PrivilegedXrootdLauncher) Launch(ctx context.Context) (context.Context, int, error)

func (PrivilegedXrootdLauncher) Name

func (launcher PrivilegedXrootdLauncher) Name() string

type ScitokensCfg

type ScitokensCfg struct {
	Global    GlobalCfg
	IssuerMap map[string]Issuer
}

Top-level configuration object for the template

func LoadScitokensConfig

func LoadScitokensConfig(fileName string) (cfg ScitokensCfg, err error)

Given a filename, load and parse the file into a ScitokensCfg object

type ServerConfig

type ServerConfig struct {
	TLSCertificate            string
	TLSKey                    string
	TLSCACertificateDirectory string
	TLSCACertificateFile      string
}

type UnprivilegedXrootdLauncher

type UnprivilegedXrootdLauncher struct {
	daemon.DaemonLauncher
	// contains filtered or unexported fields
}

type XrootdConfig

type XrootdConfig struct {
	Server  ServerConfig
	Origin  OriginConfig
	Xrootd  XrootdOptions
	Cache   CacheConfig
	Logging LoggingConfig
}

type XrootdOptions

type XrootdOptions struct {
	Port                   int
	ManagerHost            string
	ManagerPort            string
	ConfigFile             string
	MacaroonsKeyFile       string
	RobotsTxtFile          string
	Sitename               string
	SummaryMonitoringHost  string
	SummaryMonitoringPort  int
	DetailedMonitoringHost string
	DetailedMonitoringPort int
	Authfile               string
	ScitokensConfig        string
	Mount                  string
	LocalMonitoringPort    int
}