cfg

Documentation

Index

• Variables
• func Parse()
• func ParsePluginFQNs() ([]model.PluginFQN, error)
• func Print()

Variables

var (
	// FilePath path to config file.
	FilePath string

	// PushStatusesEndpoint where to push statuses.
	PushStatusesEndpoint string

	// AuthEnabled whether authentication is needed
	AuthEnabled bool

	// Token to access wsmaster API
	Token string

	// RuntimeID the id of workspace runtime this machine belongs to.
	RuntimeID model.RuntimeID

	// DisablePushingToEndpoint disables pushing anything to the endpoint
	DisablePushingToEndpoint bool

	// PrintEventsOnly disable output of broker logs and instead prints events that are supposed
	// to be sent to endpoint. This helps imitate what info about plugin brokering
	// a user would see
	PrintEventsOnly bool

	// UseLocalhostInPluginUrls configures the broker to use the `localhost` name
	// instead of the Kubernetes service name to build Theia or VSCode plugin
	// endpoint URL
	// True by default since until now all remote VS Code or Theia plugin containers
	// are started on the same POD as the Theia IDE container
	UseLocalhostInPluginUrls = true

	// OnlyApplyMetadataActions configures the broker to only apply metadata-related
	// steps, without copying any file into the `plugins` directory
	OnlyApplyMetadataActions bool

	// RegistryAddress address of the plugin registry, if plugin IDs are specified in config instead of metas.
	// Used as a default registry if a plugin fully-qualified name does not specify a registry.
	RegistryAddress string

	// SelfSignedCertificateFilePath path to certificate file that should be used while connection establishing to Che server.
	// Usually it contains Che server self-signed certificate.
	SelfSignedCertificateFilePath string

	// CABundleDirPath Path to directory with trusted CA certificates.
	// Usually they contain all the trusted CA in the cluster.
	CABundleDirPath string

	// MergePlugins determines whether the brokers should attempt to merge plugins
	// when they run in the same sidecar image
	MergePlugins bool
)

Functions

func Parse

func Parse()

Parse parses configuration.

func ParsePluginFQNs

func ParsePluginFQNs() ([]model.PluginFQN, error)

ParsePluginFQNs reads content of file at path cfg.Filepath and parses its content as a list of fully-qualified Plugin names (id, version, registry). If any error occurs, log.Fatal is called.

func Print

func Print()

Print prints configuration.