config

type APIServer struct {
	// ApplicationsEndpoint is the URL of the applications endpoint
	ApplicationsEndpoint string `json:"applications_endpoint,omitempty"`
	// ExperimentsEndpoint is the URL of the experiments endpoint
	ExperimentsEndpoint string `json:"experiments_endpoint,omitempty"`
	// AccountsEndpoint is the URL of the accounts endpoint
	AccountsEndpoint string `json:"accounts_endpoint,omitempty"`
	// PerformanceTokenEndpoint is the URL of the Performance API token endpoint
	PerformanceTokenEndpoint string `json:"performance_token_endpoint,omitempty"`
}

type ApplicationServer struct {
	// BaseURL is the main entrypoint to the application.
	BaseURL string `json:"base_url,omitempty"`
	// AuthSuccessEndpoint is URL to direct the user to after a successful login.
	AuthSuccessEndpoint string `json:"auth_success_endpoint,omitempty"`
}

type Authorization struct {
	// Credential is the information that must be presented to prove authorization
	Credential Credential `json:"credential"`
}

type AuthorizationServer struct {
	// Issuer is the authorization server's identifier, it must be an "https" URL with no query or fragment
	Issuer string `json:"issuer"`
	// AuthorizationEndpoint is the URL of the authorization endpoint
	AuthorizationEndpoint string `json:"authorization_endpoint,omitempty"`
	// TokenEndpoint is the URL of the token endpoint
	TokenEndpoint string `json:"token_endpoint,omitempty"`
	// RevocationEndpoint is the URL of the revocation endpoint
	RevocationEndpoint string `json:"revocation_endpoint,omitempty"`
	// RegistrationEndpoint is the URL of the dynamic client registration endpoint
	RegistrationEndpoint string `json:"registration_endpoint,omitempty"`
	// DeviceAuthorizationEndpoint is the URL of the device flow authorization endpoint
	DeviceAuthorizationEndpoint string `json:"device_authorization_endpoint,omitempty"`
	// JSONWebKeySetURI is URL of the JSON Web Key Set
	JSONWebKeySetURI string `json:"jwks_uri,omitempty"`
}

type Change func(cfg *Config) error

type ClientCredential struct {
	// ClientID is the client identifier
	ClientID string `json:"client_id"`
	// ClientSecret is the client secret
	ClientSecret string `json:"client_secret"`
	// Scope is the space delimited list of allowable scopes for the client
	Scope string `json:"scope"`
}

type ClientIdentity func(string) string

type Cluster struct {
	// KubeConfig is the path to a kubeconfig file to use; leave blank to get the default file
	KubeConfig string `json:"kubeconfig,omitempty"`
	// Context is the kubeconfig context to use for the cluster; leave blank to get the current kubeconfig context
	Context string `json:"context"`
	// Namespace overrides the kubeconfig namespace to use for the cluster; leave blank to get the current kubeconfig namespace
	Namespace string `json:"namespace"`
	// Bin is the path to the kubectl binary to use
	Bin string `json:"bin,omitempty"`
	// Controller is the reference to a controller section to use when configuring this cluster
	Controller string `json:"controller,omitempty"`
}

type Config struct {
	// Servers is a named list of server configurations
	Servers []NamedServer `json:"servers,omitempty"`
	// Authorizations is a named list of authorizations configurations
	Authorizations []NamedAuthorization `json:"authorizations,omitempty"`
	// Clusters is a named list of cluster configurations
	Clusters []NamedCluster `json:"clusters,omitempty"`
	// Controllers is a named list of controller configurations
	Controllers []NamedController `json:"controllers,omitempty"`
	// Contexts is a named list of context configurations
	Contexts []NamedContext `json:"contexts,omitempty"`
	// CurrentContext is the name of the default context
	CurrentContext string `json:"current-context,omitempty"`
	// Environment identifies the current execution environment
	Environment string `json:"env,omitempty"`
}

type Context struct {
	// Server is the name of the remote server to connect to
	Server string `json:"server,omitempty"`
	// Authorization is the name of authorization configuration to use
	Authorization string `json:"authorization,omitempty"`
	// Cluster is the name of the Kubernetes cluster to connect to; it is a name in THIS configuration and does not correspond to the kubeconfig name
	Cluster string `json:"cluster,omitempty"`
}

type Controller struct {
	// DeploymentName is the name of the controller deployment object
	DeploymentName string `json:"deploymentName,omitempty"`
	// Namespace overrides the default namespace to use during configuration
	Namespace string `json:"namespace,omitempty"`
	// RegistrationClientURI is the fully qualified URL of the client configuration endpoint for the controller's client
	RegistrationClientURI string `json:"registration_client_uri,omitempty"`
	// RegistrationAccessToken is the access token to be used for the client configuration endpoint
	RegistrationAccessToken string `json:"registration_access_token,omitempty"`
	// Env defines additional environment variables to load into the controller during authorization
	Env []ControllerEnvVar `json:"env,omitempty"`
	// Resources allows overriding the default container resources for the controller.
	Resources *ControllerResources `json:"resources,omitempty"`
}

type ControllerEnvVar struct {
	// Name of the environment variable
	Name string `json:"name"`
	// Value of the environment variable
	Value string `json:"value"`
}

type ControllerResources struct {
	// Requests for container resources, keyed by resource type.
	Requests map[string]string `json:"requests,omitempty"`
	// Limits for container resources, keyed by resource type.
	Limits map[string]string `json:"limits,omitempty"`
}

type Credential struct {
	// TokenCredential is used to prove authorization using a token that has already been obtained
	*TokenCredential
	// ClientCredential is used to obtain a new token for authorization using the credential information
	*ClientCredential
}

type Loader func(cfg *OptimizeConfig) error

type NamedAuthorization struct {
	// Name is the referencable name for the authorization
	Name string `json:"name"`
	// Authorization is the authorization configuration
	Authorization Authorization `json:"authorization"`
}

type NamedCluster struct {
	// Name is the referencable name for the cluster
	Name string `json:"name"`
	// Cluster is the cluster configuration
	Cluster Cluster `json:"cluster"`
}

type NamedContext struct {
	// Name is the referencable name for the context
	Name string `json:"name"`
	// Context is the context configuration
	Context Context `json:"context"`
}

type NamedController struct {
	// Name is the referencable name for the controller
	Name string `json:"name"`
	// Controller is the cluster configuration
	Controller Controller `json:"controller"`
}

type NamedServer struct {
	// Name is the referencable name for the server
	Name string `json:"name"`
	// Server is the server configuration
	Server Server `json:"server"`
}

type OptimizeConfig struct {
	// Filename is the path to the configuration file; if left blank, it will be populated using XDG base directory conventions on the next Load
	Filename string
	// Overrides to the standard configuration
	Overrides Overrides
	// ClientIdentity is used to determine the OAuth 2.0 client identifier
	ClientIdentity ClientIdentity
	// AuthorizationParameters is used to provide additional parameters to the OAuth 2.0 endpoints
	AuthorizationParameters map[string][]string
	// contains filtered or unexported fields
}

type Overrides struct {
	// Environment overrides the execution environment name
	Environment string
	// Context overrides the current Optimize context name (_not_ the KubeConfig context)
	Context string
	// SystemNamespace overrides the current controller namespace (_not_ the Kube namespace)
	SystemNamespace string
	// ServerIdentifier overrides the current server's identifier and StormForge endpoints. Using this override, it is not possible to specify individual endpoint locations.
	ServerIdentifier string
	// ServerIssuer overrides the current server's authorization server issuer. Using this override, it is not possible to specify individual endpoint locations.
	ServerIssuer string
	// Credential overrides the current authorization
	Credential ClientCredential
	// KubeConfig overrides the current cluster's kubeconfig file
	KubeConfig string
	// Namespace overrides the current cluster's default namespace
	Namespace string
}

type Reader interface {
	// ServerName returns the server name for the specified context
	ServerName(contextName string) (string, error)
	// Server returns the named server configuration
	Server(name string) (Server, error)
	// AuthorizationName returns authorization name for the specified context
	AuthorizationName(contextName string) (string, error)
	// Authorization returns the named authorization configuration
	Authorization(name string) (Authorization, error)
	// ClusterName returns cluster name for the specified context
	ClusterName(contextName string) (string, error)
	// Cluster returns the named cluster configuration
	Cluster(name string) (Cluster, error)
	// ControllerName returns controller name for the specified context (derived via the cluster)
	ControllerName(contextName string) (string, error)
	// Controller returns the named controller configuration
	Controller(name string) (Controller, error)
	// ContextName returns current context name
	ContextName() string
	// Context returns the named context configuration
	Context(name string) (Context, error)
}

type RevocationInformation struct {
	// RevocationURL is the URL of the authorization server's revocation endpoint
	RevocationURL string
	// ClientID is the client identifier for the authorization
	ClientID string
	// Authorization is the credential that needs to be revoked
	Authorization Authorization
	// contains filtered or unexported fields
}

type Server struct {
	// Identifier is a URI used to identify a common set of endpoints making up a StormForge API Server. The identifier
	// may be used to resolve ".well-known" locations, used as an authorization audience, or used as a common base URL
	// when determining default endpoint addresses. The URL must not have any query or fragment components.
	Identifier string `json:"identifier"`
	// API contains the API server metadata necessary to access the programmatic interface.
	API APIServer `json:"api"`
	// Authorization contains the authorization server metadata necessary to access this server
	Authorization AuthorizationServer `json:"authorization"`
	// Application contains information about the public facing user interface.
	Application ApplicationServer `json:"application"`
}

type TokenCredential struct {
	// AccessToken is presented to the service being authenticated to
	AccessToken string `json:"access_token"`
	// TokenType is the type of the access token (i.e. "bearer")
	TokenType string `json:"token_type,omitempty"`
	// RefreshToken is presented to the authorization server when the access token expires
	RefreshToken string `json:"refresh_token,omitempty"`
	// Expiry is the time at which the access token expires (or 0 if the token does not expire)
	Expiry time.Time `json:"expiry,omitempty"`
}