server

Documentation

Index

• Constants
• func RepoNameToEnvString(repoName string) string
• type APIServer
  • func NewAPIServer(env *serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv, etcdPrefix string, ...) (APIServer, error)
  • func NewSidecarAPIServer(env *serviceenv.ServiceEnv, etcdPrefix string, iamRole string, ...) (APIServer, error)
• type ActiveStat
  • func CollectActiveObjectsAndTags(ctx context.Context, pachClient *client.APIClient, repoInfos []*pfs.RepoInfo, ...) (*ActiveStat, error)

Constants

const (
	// DefaultUserImage is the image used for jobs when the user does not specify
	// an image.
	DefaultUserImage = "ubuntu:16.04"
	// DefaultDatumTries is the default number of times a datum will be tried
	// before we give up and consider the job failed.
	DefaultDatumTries = 3
)

Functions

func RepoNameToEnvString

func RepoNameToEnvString(repoName string) string

RepoNameToEnvString is a helper which uppercases a repo name for use in environment variable names.

Types

type APIServer

type APIServer interface {
	ppsclient.APIServer
}

APIServer represents a PPS API server

func NewAPIServer

func NewAPIServer(
	env *serviceenv.ServiceEnv,
	txnEnv *txnenv.TransactionEnv,
	etcdPrefix string,
	namespace string,
	workerImage string,
	workerSidecarImage string,
	workerImagePullPolicy string,
	storageRoot string,
	storageBackend string,
	storageHostPath string,
	iamRole string,
	imagePullSecret string,
	noExposeDockerSocket bool,
	reporter *metrics.Reporter,
	workerUsesRoot bool,
	workerGrpcPort uint16,
	port uint16,
	pprofPort uint16,
	httpPort uint16,
	peerPort uint16,
) (APIServer, error)

NewAPIServer creates an APIServer.

func NewSidecarAPIServer

func NewSidecarAPIServer(
	env *serviceenv.ServiceEnv,
	etcdPrefix string,
	iamRole string,
	reporter *metrics.Reporter,
	workerGrpcPort uint16,
	pprofPort uint16,
	httpPort uint16,
	peerPort uint16,
) (APIServer, error)

NewSidecarAPIServer creates an APIServer that has limited functionalities and is meant to be run as a worker sidecar. It cannot, for instance, create pipelines.

type ActiveStat

type ActiveStat struct {
	Objects  *bloom.BloomFilter
	NObjects int
	Tags     *bloom.BloomFilter
	NTags    int
}

ActiveStat contains stats about the object objects and tags in the filesystem. It is returned by CollectActiveObjectsAndTags.

func CollectActiveObjectsAndTags

func CollectActiveObjectsAndTags(ctx context.Context, pachClient *client.APIClient, repoInfos []*pfs.RepoInfo, pipelineInfos []*pps.PipelineInfo, memoryAllowance int, storageRoot string) (*ActiveStat, error)

CollectActiveObjectsAndTags collects all objects/tags that are not deleted or eligible for garbage collection