assets

Documentation

Index

• func AmazonSecret(bucket string, distribution string, id string, secret string, token string, ...) *api.Secret
• func DashDeployment(dashImage string) *extensions.Deployment
• func DashService() *v1.Service
• func EtcdDeployment(opts *AssetOpts, hostPath string) *extensions.Deployment
• func EtcdHeadlessService() *v1.Service
• func EtcdNodePortService(local bool) *v1.Service
• func EtcdStatefulSet(opts *AssetOpts, backend backend, diskSpace int) interface{}
• func EtcdStorageClass(backend backend) (interface{}, error)
• func EtcdVolume(persistentDiskBackend backend, opts *AssetOpts, hostPath string, name string, ...) (*api.PersistentVolume, error)
• func EtcdVolumeClaim(size int) *api.PersistentVolumeClaim
• func GetSecretVolumeAndMount(backend string) (api.Volume, api.VolumeMount, error)
• func GoogleSecret(bucket string) *api.Secret
• func MicrosoftSecret(container string, id string, secret string) *api.Secret
• func MinioSecret(bucket string, id string, secret string, endpoint string, secure bool) *api.Secret
• func PachdDeployment(opts *AssetOpts, objectStoreBackend backend, hostPath string) *extensions.Deployment
• func PachdService() *v1.Service
• func ServiceAccount() *api.ServiceAccount
• func WriteAmazonAssets(w io.Writer, opts *AssetOpts, bucket string, id string, secret string, ...) error
• func WriteAssets(w io.Writer, opts *AssetOpts, objectStoreBackend backend, ...) error
• func WriteCustomAssets(w io.Writer, opts *AssetOpts, args []string, objectStoreBackend string, ...) error
• func WriteDashboardAssets(w io.Writer, opts *AssetOpts)
• func WriteGoogleAssets(w io.Writer, opts *AssetOpts, bucket string, volumeSize int) error
• func WriteLocalAssets(w io.Writer, opts *AssetOpts, hostPath string) error
• func WriteMicrosoftAssets(w io.Writer, opts *AssetOpts, container string, id string, secret string, ...) error
• type AssetOpts

Functions

func AmazonSecret

func AmazonSecret(bucket string, distribution string, id string, secret string, token string, region string) *api.Secret

AmazonSecret creates an amazon secret with the following parameters:

bucket - S3 bucket name
id     - AWS access key id
secret - AWS secret access key
token  - AWS access token
region - AWS region

func DashDeployment

func DashDeployment(dashImage string) *extensions.Deployment

DashDeployment creates a Deployment for the pachyderm dashboard.

func DashService

func DashService() *v1.Service

DashService creates a Service for the pachyderm dashboard.

func EtcdDeployment

func EtcdDeployment(opts *AssetOpts, hostPath string) *extensions.Deployment

EtcdDeployment returns an etcd k8s Deployment.

func EtcdHeadlessService

func EtcdHeadlessService() *v1.Service

EtcdHeadlessService returns a headless etcd service, which is only for DNS resolution.

func EtcdNodePortService

func EtcdNodePortService(local bool) *v1.Service

EtcdNodePortService returns a NodePort etcd service. This will let non-etcd pods talk to etcd

func EtcdStatefulSet

func EtcdStatefulSet(opts *AssetOpts, backend backend, diskSpace int) interface{}

EtcdStatefulSet returns a stateful set that manages an etcd cluster

func EtcdStorageClass

func EtcdStorageClass(backend backend) (interface{}, error)

EtcdStorageClass creates a storage class used for dynamic volume provisioning. Currently dynamic volume provisioning only works on AWS and GCE.

func EtcdVolume

func EtcdVolume(persistentDiskBackend backend, opts *AssetOpts,
	hostPath string, name string, size int) (*api.PersistentVolume, error)

EtcdVolume creates a persistent volume backed by a volume with name "name"

func EtcdVolumeClaim

func EtcdVolumeClaim(size int) *api.PersistentVolumeClaim

EtcdVolumeClaim creates a persistent volume claim of 'size' GB.

Note that if you're controlling Etcd with a Stateful Set, this is unneccessary (the stateful set controller will create PVCs automatically).

func GetSecretVolumeAndMount

func GetSecretVolumeAndMount(backend string) (api.Volume, api.VolumeMount, error)

GetSecretVolumeAndMount returns a properly configured Volume and VolumeMount object given a backend. The backend needs to be one of the constants defined in pfs/server.

func GoogleSecret

func GoogleSecret(bucket string) *api.Secret

GoogleSecret creates a google secret with a bucket name.

func MicrosoftSecret

func MicrosoftSecret(container string, id string, secret string) *api.Secret

MicrosoftSecret creates a microsoft secret with following parameters:

container - Azure blob container
id    	   - Azure storage account name
secret    - Azure storage account key

func MinioSecret

func MinioSecret(bucket string, id string, secret string, endpoint string, secure bool) *api.Secret

MinioSecret creates an amazon secret with the following parameters:

bucket - S3 bucket name
id     - S3 access key id
secret - S3 secret access key
endpoint  - S3 compatible endpoint
secure - set to true for a secure connection.

func PachdDeployment

func PachdDeployment(opts *AssetOpts, objectStoreBackend backend, hostPath string) *extensions.Deployment

PachdDeployment returns a pachd k8s Deployment.

func PachdService

func PachdService() *v1.Service

PachdService returns a pachd service.

func ServiceAccount

func ServiceAccount() *api.ServiceAccount

ServiceAccount returns a kubernetes service account for use with Pachyderm.

func WriteAmazonAssets

func WriteAmazonAssets(w io.Writer, opts *AssetOpts, bucket string, id string, secret string,
	token string, region string, volumeSize int, distribution string) error

WriteAmazonAssets writes assets to an amazon backend.

func WriteAssets

func WriteAssets(w io.Writer, opts *AssetOpts, objectStoreBackend backend,
	persistentDiskBackend backend, volumeSize int,
	hostPath string) error

WriteAssets writes the assets to w.

func WriteCustomAssets

func WriteCustomAssets(w io.Writer, opts *AssetOpts, args []string, objectStoreBackend string,
	persistentDiskBackend string, secure bool) error

WriteCustomAssets writes assets to a custom combination of object-store and persistent disk.

func WriteDashboardAssets

func WriteDashboardAssets(w io.Writer, opts *AssetOpts)

WriteDashboardAssets writes the k8s config for deploying the Pachyderm dashboard to 'w'

func WriteGoogleAssets

func WriteGoogleAssets(w io.Writer, opts *AssetOpts, bucket string, volumeSize int) error

WriteGoogleAssets writes assets to a google backend.

func WriteLocalAssets

func WriteLocalAssets(w io.Writer, opts *AssetOpts, hostPath string) error

WriteLocalAssets writes assets to a local backend.

func WriteMicrosoftAssets

func WriteMicrosoftAssets(w io.Writer, opts *AssetOpts, container string, id string, secret string, volumeSize int) error

WriteMicrosoftAssets writes assets to a microsoft backend

Types

type AssetOpts

type AssetOpts struct {
	PachdShards uint64
	Version     string
	LogLevel    string
	Metrics     bool
	Dynamic     bool
	EtcdNodes   int
	EtcdVolume  string
	EnableDash  bool
	DashOnly    bool
	DashImage   string

	// BlockCacheSize is the amount of memory each PachD node allocates towards
	// its cache of PFS blocks. If empty, assets.go will choose a default size.
	BlockCacheSize string

	// PachdCPURequest is the amount of CPU we request for each pachd node. If
	// empty, assets.go will choose a default size.
	PachdCPURequest string

	// PachdNonCacheMemRequest is the amount of memory we request for each
	// pachd node in addition to BlockCacheSize. If empty, assets.go will choose
	// a default size.
	PachdNonCacheMemRequest string

	// EtcdCPURequest is the amount of CPU (in cores) we request for each etcd
	// node. If empty, assets.go will choose a default size.
	EtcdCPURequest string

	// EtcdMemRequest is the amount of memory we request for each etcd node. If
	// empty, assets.go will choose a default size.
	EtcdMemRequest string
}

AssetOpts are options that are applicable to all the asset types.