assets

Documentation

Index

• func AddRegistry(registry string, imageName string) string
• func AmazonSecret(bucket string, distribution string, id string, secret string, token string, ...) map[string][]byte
• func DashDeployment(opts *AssetOpts) *apps.Deployment
• func DashService() *v1.Service
• func EtcdDeployment(opts *AssetOpts, hostPath string) *apps.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, ...) (*v1.PersistentVolume, error)
• func EtcdVolumeClaim(size int) *v1.PersistentVolumeClaim
• func GetSecretVolumeAndMount(backend string) (v1.Volume, v1.VolumeMount)
• func GoogleSecret(bucket string) map[string][]byte
• func Images(opts *AssetOpts) []string
• func LocalSecret() map[string][]byte
• func MicrosoftSecret(container string, id string, secret string) map[string][]byte
• func MinioSecret(bucket string, id string, secret string, endpoint string, secure, isS3V2 bool) map[string][]byte
• func PachdDeployment(opts *AssetOpts, objectStoreBackend backend, hostPath string) *apps.Deployment
• func PachdService() *v1.Service
• func ServiceAccount() *v1.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
• func WriteSecret(w io.Writer, data map[string][]byte)
• type AssetOpts

Functions

func AddRegistry

func AddRegistry(registry string, imageName string) string

AddRegistry switchs the registry that an image is targetting.

func AmazonSecret

func AmazonSecret(bucket string, distribution string, id string, secret string, token string, region string) map[string][]byte

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(opts *AssetOpts) *apps.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) *apps.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) (*v1.PersistentVolume, error)

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

func EtcdVolumeClaim

func EtcdVolumeClaim(size int) *v1.PersistentVolumeClaim

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

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

func GetSecretVolumeAndMount

func GetSecretVolumeAndMount(backend string) (v1.Volume, v1.VolumeMount)

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) map[string][]byte

GoogleSecret creates a google secret with a bucket name.

func Images

func Images(opts *AssetOpts) []string

Images returns a list of all the images that are used by a pachyderm deployment.

func LocalSecret

func LocalSecret() map[string][]byte

LocalSecret creates an empty secret.

func MicrosoftSecret

func MicrosoftSecret(container string, id string, secret string) map[string][]byte

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, isS3V2 bool) map[string][]byte

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.
isS3V2 - Set to true if client follows S3V2

func PachdDeployment

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

PachdDeployment returns a pachd k8s Deployment.

func PachdService

func PachdService() *v1.Service

PachdService returns a pachd service.

func ServiceAccount

func ServiceAccount() *v1.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, isS3V2 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

func WriteSecret

func WriteSecret(w io.Writer, data map[string][]byte)

WriteSecret writes a JSON-encoded k8s secret to the given writer. The secret uses the given map as data.

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
	Registry    string

	// NoGuaranteed will not generate assets that have both resource limits and
	// resource requests set which causes kubernetes to give the pods
	// guaranteed QoS. Guaranteed QoS generally leads to more stable clusters
	// but on smaller test clusters such as those run on minikube it doesn't
	// help much and may cause more instability than it prevents.
	NoGuaranteed bool

	// DisableAuthentication stops Pachyderm's authentication service
	// from talking to GitHub, for testing. Instead users can authenticate
	// simply by providing a username.
	DisableAuthentication bool

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

	// IAMRole is the IAM role that the Pachyderm deployment should
	// assume when talking to AWS services.
	IAMRole string

	// ImagePullSecret specifies an image pull secret that gets attached to the
	// various deployments so that their images can be pulled from a private
	// registry.
	ImagePullSecret string
}

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