datastore.go

package config

const (
	// BuildDriverDocker is no longer supported.
	BuildDriverDocker = "docker"

	// BuildDriverBuildkit is the configuration value for specifying BuildKit as
	// the build driver.
	BuildDriverBuildkit = "buildkit"

	// RuntimeDriverDocker specifies that the bundle image should be executed on docker.
	RuntimeDriverDocker = "docker"

	// RuntimeDriverKubernetes specifies that the bundle image should be executed on kubernetes.
	RuntimeDriverKubernetes = "kubernetes"
)

// Data is the data stored in PORTER_HOME/porter.toml|yaml|json.
// Use the accessor functions to ensure default values are handled properly.
type Data struct {
	// Only define fields here that you need to access from code
	// Values are dynamically applied to flags and don't need to be defined

	// BuildDriver is the driver to use when building bundles.
	// Available values are: buildkit.
	// Do not use directly, use Config.GetBuildDriver.
	BuildDriver string `mapstructure:"build-driver"`

	// RuntimeDriver is the driver to use when executing bundles.
	// Available values are: docker, kubernetes.
	// It is both a global variable and a command flag because some of our commands, like porter installation apply,
	// do not expose all the bundle execution flags. This allows us to later manually use the global config value
	// to ensure that the global config value works even for those commands.
	RuntimeDriver string `mapstructure:"runtime-driver"`

	// ForceOverwrite specifies OCI artifacts can be overwritten when pushed.
	// By default, Porter requires the --force flag to be specified to overwrite a bundle or image.
	ForceOverwrite bool `mapstructure:"force-overwrite"`

	// AllowDockerHostAccess grants bundles access to the underlying docker host
	// upon which it is running so that it can do things like build and run containers.
	// It's a security risk.
	// It is both a global variable and a command flag because some of our commands, like porter installation apply,
	// do not expose all the bundle execution flags. This allows us to later manually use the global config value
	// to ensure that the global config value works even for those commands.
	AllowDockerHostAccess bool `mapstructure:"allow-docker-host-access"`

	// DefaultStoragePlugin is the storage plugin to use when no named storage is specified.
	DefaultStoragePlugin string `mapstructure:"default-storage-plugin"`

	// DefaultStorage to use when a named storage is not specified by a flag.
	DefaultStorage string `mapstructure:"default-storage"`

	// ExperimentalFlags is a list of enabled experimental.FeatureFlags.
	// Use Config.IsFeatureEnabled instead of parsing directly.
	ExperimentalFlags []string `mapstructure:"experimental"`

	// StoragePlugins defined in the configuration file.
	StoragePlugins []StoragePlugin `mapstructure:"storage"`

	// DefaultSecretsPlugin is the plugin to use when no plugin is specified.
	DefaultSecretsPlugin string `mapstructure:"default-secrets-plugin"`

	// DefaultSecrets to use when one is not specified by a flag.
	DefaultSecrets string `mapstructure:"default-secrets"`

	// DefaultSigningPlugin is the plugin to use when no plugin is specified.
	DefaultSigningPlugin string `mapstructure:"default-signing-plugin"`

	// DefaultSigning to use when one is not specified by a flag.
	DefaultSigning string `mapstructure:"default-signer"`

	// Namespace is the default namespace for commands that do not override it with a flag.
	Namespace string `mapstructure:"namespace"`

	// SecretsPlugin defined in the configuration file.
	SecretsPlugin []SecretsPlugin `mapstructure:"secrets"`

	// SigningPlugin defined in the configuration file.
	SigningPlugin []SigningPlugin `mapstructure:"signers"`

	// Logs are settings related to Porter's log files.
	Logs LogConfig `mapstructure:"logs"`

	// Telemetry are settings related to Porter's tracing with open telemetry.
	Telemetry TelemetryConfig `mapstructure:"telemetry"`

	// SchemaCheck specifies how strict Porter should be when comparing the
	// schemaVersion field on a resource with the supported schemaVersion.
	// Supported values are: exact, minor, major, none.
	SchemaCheck string `mapstructure:"schema-check"`

	// Verbosity controls the level of messages output to the console.
	// Use Logs.LogLevel if you want to change what is output to the logfile.
	// Traces sent to an OpenTelemetry collector always include all levels of messages.
	Verbosity string `mapstructure:"verbosity"`
}

// DefaultDataStore used when no config file is found.
func DefaultDataStore() Data {
	return Data{
		BuildDriver:          BuildDriverBuildkit,
		RuntimeDriver:        RuntimeDriverDocker,
		DefaultStoragePlugin: "mongodb-docker",
		DefaultSecretsPlugin: "host",
		DefaultSigningPlugin: "",
		Logs:                 LogConfig{Level: "info"},
		Verbosity:            DefaultVerbosity,
	}
}

// SigningPlugin is the plugin stanza for signing.
type SigningPlugin struct {
	PluginConfig `mapstructure:",squash"`
}

// SecretsPlugin is the plugin stanza for secrets.
type SecretsPlugin struct {
	PluginConfig `mapstructure:",squash"`
}

// StoragePlugin is the plugin stanza for storage.
type StoragePlugin struct {
	PluginConfig `mapstructure:",squash"`
}

// PluginConfig is a standardized config stanza that defines which plugin to
// use and its custom configuration.
type PluginConfig struct {
	Name         string                 `mapstructure:"name"`
	PluginSubKey string                 `mapstructure:"plugin"`
	Config       map[string]interface{} `mapstructure:"config"`
}

func (p PluginConfig) GetName() string {
	return p.Name
}

func (p PluginConfig) GetPluginSubKey() string {
	return p.PluginSubKey
}

func (p PluginConfig) GetConfig() interface{} {
	return p.Config
}