pachd

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 EnterpriseMode(ctx context.Context, config *pachconfig.EnterpriseServerConfiguration) error
• func FullMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
• func PachwMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
• func PausedMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error
• func PreflightMode(ctx context.Context, config *pachconfig.PachdPreflightConfiguration) error
• func SidecarMode(ctx context.Context, config *pachconfig.PachdFullConfiguration) error

Functions

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 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 PreflightMode

func PreflightMode(ctx context.Context, config *pachconfig.PachdPreflightConfiguration) error

PreflightMode runs pachd's preflight checks. It is safe to run these at any time, even for a version different than the currently-running full pachd version.

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.