volume_mount_options

README

volume-mount-options

This is a library that is imported by various parts of CloudFoundry volume services.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/volume-mount-options.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Volume Services area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• Constants
• type MountOpts
  • func NewMountOpts(userOpts map[string]interface{}, mask MountOptsMask) (MountOpts, error)
• type MountOptsMask
  • func NewMountOptsMask(allowed []string, defaults map[string]interface{}, keyPerms map[string]string, ...) (MountOptsMask, error)
• type UserOptsValidation
• type UserOptsValidationFunc
  • func (v UserOptsValidationFunc) Validate(a string, b string) error

Constants

const MissingOptionErrorMessage = "- Missing mandatory options: %s"

const NotAllowedErrorMessage = "- Not allowed options: %s"

const ValidationFailErrorMessage = "- validation mount options failed: %s"

Types

type MountOpts

type MountOpts map[string]interface{}

func NewMountOpts

func NewMountOpts(userOpts map[string]interface{}, mask MountOptsMask) (MountOpts, error)

type MountOptsMask

type MountOptsMask struct {
	Allowed        []string
	Defaults       map[string]interface{}
	KeyPerms       map[string]string
	Ignored        []string
	Mandatory      []string
	SloppyMount    bool
	ValidationFunc []UserOptsValidation
}

func NewMountOptsMask

func NewMountOptsMask(allowed []string,
	defaults map[string]interface{},
	keyPerms map[string]string,
	ignored, mandatory []string,
	f ...UserOptsValidation) (MountOptsMask, error)

type UserOptsValidation

type UserOptsValidation interface {
	Validate(string, string) error
}

type UserOptsValidationFunc

type UserOptsValidationFunc func(string, string) error

func (UserOptsValidationFunc) Validate

func (v UserOptsValidationFunc) Validate(a string, b string) error