profiles

Documentation

Index

• func ListProfiles(location string) ([]string, error)
• func WriteProfileFile(name, location string, config *configs.ProfileCreateConfig) error
• type ResolvedProfile
  • func ReadProfile(name, location string) (ResolvedProfile, error)

Functions

func ListProfiles

func ListProfiles(location string) ([]string, error)

ListProfiles list available profiles. Retuns a sorted list of profile names.

func WriteProfileFile

func WriteProfileFile(name, location string, config *configs.ProfileCreateConfig) error

WriteProfileFile writes the profile to a file named wuth `name` in the `location` directory. Name is always lowercase.

Types

type ResolvedProfile

type ResolvedProfile interface {
	// Returns a merged storage configuration.
	GetMergedStorageConfig() map[string]interface{}
	// Returns an underlying profile.
	Profile() *model.Profile
	// Updates the config of the underlying profile.
	// Changes anre not automatically persisted.
	UpdateConfigs(...configs.ProfileInheriting) error
}

ResolvedProfile provides additional functionality to a profile loaded from disk.

func ReadProfile

func ReadProfile(name, location string) (ResolvedProfile, error)

ReadProfile reads the profile information for a profile name and profile directory. Name is always lowercase.