Documentation ¶
Overview ¶
Package pachd implements the Pachyderm dæmon and its various modes.
Callers need only provide a context and a configuration.
Adding a new mode ¶
The idea is that there is a builder for each mode; each builder is responsible for building and running an instance of the single type daemon representing a pachd instance.
To add a new mode one will at least add a new builder; one may also need to add new members to daemon. Daemon should contain only those members needed at run time for any mode; other, transient, values should be members of the pertinent builder.
Index ¶
- func AdminEnv(senv serviceenv.ServiceEnv, paused bool) admin_server.Env
- func AuthEnv(senv serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv) auth_server.Env
- func DebugEnv(env serviceenv.ServiceEnv) debug_server.Env
- func EnterpriseEnv(senv serviceenv.ServiceEnv, etcdPrefix string, txEnv *txnenv.TransactionEnv) *enterprise_server.Env
- func EnterpriseMode(ctx context.Context, config *pachconfig.EnterpriseServerConfiguration) error
- func FullMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
- func LicenseEnv(senv serviceenv.ServiceEnv) *license_server.Env
- func NewTestPachd(t testing.TB) *client.APIClient
- func PFSEnv(env serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv) (*pfs_server.Env, error)
- func PFSWorkerEnv(env serviceenv.ServiceEnv) (*pfs_server.WorkerEnv, error)
- func PPSEnv(senv serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv, ...) pps_server.Env
- func PachwEnv(env serviceenv.ServiceEnv) (*pachw_server.Env, error)
- func PachwMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
- func PausedMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
- func SidecarMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
- type Env
- type Full
- type PreFlight
- type PreFlightEnv
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AdminEnv ¶ added in v2.8.0
func AdminEnv(senv serviceenv.ServiceEnv, paused bool) admin_server.Env
func AuthEnv ¶ added in v2.8.0
func AuthEnv(senv serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv) auth_server.Env
func DebugEnv ¶ added in v2.8.0
func DebugEnv(env serviceenv.ServiceEnv) debug_server.Env
func EnterpriseEnv ¶ added in v2.8.0
func EnterpriseEnv(senv serviceenv.ServiceEnv, etcdPrefix string, txEnv *txnenv.TransactionEnv) *enterprise_server.Env
func EnterpriseMode ¶
func EnterpriseMode(ctx context.Context, config *pachconfig.EnterpriseServerConfiguration) error
EnterpriseMode runs an enterprise-mode pachd.
Enterprise mode is the enterprise server which is used to manage multiple Pachyderm installations.
func FullMode ¶
func FullMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
FullMode runs a full-mode pachd.
Full mode is that standard pachd which users interact with using pachctl and which manages pipelines, files and so forth.
func LicenseEnv ¶ added in v2.8.0
func LicenseEnv(senv serviceenv.ServiceEnv) *license_server.Env
func NewTestPachd ¶ added in v2.8.0
NewTestPachd creates an environment suitable for non-k8s tests and then calls pachd.NewFull with that environment.
func PFSEnv ¶ added in v2.8.0
func PFSEnv(env serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv) (*pfs_server.Env, error)
func PFSWorkerEnv ¶ added in v2.8.0
func PFSWorkerEnv(env serviceenv.ServiceEnv) (*pfs_server.WorkerEnv, error)
func PPSEnv ¶ added in v2.8.0
func PPSEnv(senv serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv, reporter *metrics.Reporter) pps_server.Env
func PachwEnv ¶ added in v2.8.0
func PachwEnv(env serviceenv.ServiceEnv) (*pachw_server.Env, error)
func PachwMode ¶
func PachwMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
PachwMode runs a pachw-mode pachd. When in pachw mode, the pachd instance processes storage and url tasks.
func PausedMode ¶
func PausedMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
PausedMode runs a paused-mode pachd.
Paused mode is a restricted mode which runs Pachyderm read-only in order to take offline backups.
func SidecarMode ¶
func SidecarMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
SidecarMode runs a sidecar-mode pachd.
Sidecar mode is run as a sidecar in a pipeline pod; it provides services to the pipeline worker code running in that pod.
Types ¶
type Full ¶ added in v2.8.0
type Full struct {
// contains filtered or unexported fields
}
func NewFull ¶ added in v2.8.0
func NewFull(env Env, config pachconfig.PachdFullConfiguration) *Full
NewFull sets up a new Full pachd and returns it.
type PreFlight ¶ added in v2.8.0
type PreFlight struct {
// contains filtered or unexported fields
}
PreFlight is a minimal pachd for running preflight checks.
func NewPreflight ¶ added in v2.8.0
func NewPreflight(env PreFlightEnv, config pachconfig.PachdPreflightConfiguration) *PreFlight