hostoptions

Documentation

Index

• Constants
• func WithContext(ctx context.Context, cfg *UCPConfig) context.Context
• type HostOptions
  • func NewHostOptionsFromEnvironment(configPath string) (HostOptions, error)
• type Identity
• type UCPConfig
  • func FromContext(ctx context.Context) *UCPConfig

Constants

const (
	// AuthUCPCredential is the authentication method via UCP Credential API.
	AuthUCPCredential = "UCPCredential"
	// AuthDefault is the default authentication method, such as environment variables.
	AuthDefault = "default"
)

Functions

func WithContext

func WithContext(ctx context.Context, cfg *UCPConfig) context.Context

WithContext injects ProviderConfig into the given http context.

Types

type HostOptions

type HostOptions struct {
	// Config is the bootstrap configuration loaded from config file.
	Config *UCPConfig
}

HostOptions defines all of the settings that our RP's execution environment provides.

func NewHostOptionsFromEnvironment

func NewHostOptionsFromEnvironment(configPath string) (HostOptions, error)

NewHostOptionsFromEnvironment reads the configuration from the given path and returns a HostOptions object, or an error if the configuration could not be loaded.

type Identity

type Identity struct {
	// AuthMethod represents the method of authentication for authenticating with external systems like Azure and AWS.
	AuthMethod string `yaml:"authMethod"`
}

Identity represents configuration options for authenticating with external systems like Azure and AWS.

type UCPConfig

type UCPConfig struct {
	StorageProvider  dataprovider.StorageProviderOptions      `yaml:"storageProvider"`
	Planes           []rest.Plane                             `yaml:"planes"`
	SecretProvider   provider.SecretProviderOptions           `yaml:"secretProvider"`
	MetricsProvider  metricsprovider.MetricsProviderOptions   `yaml:"metricsProvider"`
	ProfilerProvider profilerprovider.ProfilerProviderOptions `yaml:"profilerProvider"`
	QueueProvider    qprovider.QueueProviderOptions           `yaml:"queueProvider"`
	TracerProvider   trace.Options                            `yaml:"tracerProvider"`
	Logging          ucplog.LoggingOptions                    `yaml:"logging"`
	Identity         Identity                                 `yaml:"identity,omitempty"`
	UCP              config.UCPOptions                        `yaml:"ucp"`
	Location         string                                   `yaml:"location"`
}

UCPConfig includes the resource provider configuration.

func FromContext

func FromContext(ctx context.Context) *UCPConfig

FromContext extracts ProviderConfig from http context.