fleetspeak_config

Documentation

Index

• Variables
• type Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (x *Config) GetComponentsConfig() *fleetspeak_components.Config
  • func (x *Config) GetConfigurationName() string
  • func (x *Config) GetDarwinClientConfigurationFile() string
  • func (x *Config) GetLinuxClientConfigurationFile() string
  • func (x *Config) GetPublicHostPort() []string
  • func (x *Config) GetServerCertFile() string
  • func (x *Config) GetServerCertKeyFile() string
  • func (x *Config) GetServerComponentConfigurationFile() string
  • func (x *Config) GetTrustedCertFile() string
  • func (x *Config) GetTrustedCertKeyFile() string
  • func (x *Config) GetWindowsClientConfigurationFile() string
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (x *Config) String() string

Variables

var File_fleetspeak_src_config_proto_fleetspeak_config_config_proto protoreflect.FileDescriptor

Types

type Config

type Config struct {

	// An name for this installation, e.g. "Nascent" or "Nascent Staging".
	// Required.
	ConfigurationName string `protobuf:"bytes,1,opt,name=configuration_name,json=configurationName,proto3" json:"configuration_name,omitempty"`
	// A template for the components configuration file that will be generated.
	// The configuration tool will populate the https_config.key and
	// https_config.certificates fields based on the parameters below.
	ComponentsConfig *fleetspeak_components.Config `protobuf:"bytes,2,opt,name=components_config,json=componentsConfig,proto3" json:"components_config,omitempty"`
	// A file containing a PEM encoded certificate that clients should be
	// configured to trust. Typically a CA cert. If this file is not already
	// present, a 10 year self-signed CA certificate and associated private key
	// will be created.
	TrustedCertFile string `protobuf:"bytes,3,opt,name=trusted_cert_file,json=trustedCertFile,proto3" json:"trusted_cert_file,omitempty"`
	// A file containing the private key associated with trusted_cert_file, only
	// required if it is necessary to create server certificates.
	//
	// NOTE: Contains private key material. Only needs to be online when creating
	// new server certificates.
	TrustedCertKeyFile string `protobuf:"bytes,4,opt,name=trusted_cert_key_file,json=trustedCertKeyFile,proto3" json:"trusted_cert_key_file,omitempty"`
	// A file containing a PEM encoded certificate that the Fleetspeak server
	// should use to identify itself. If this file is not already present, a 1
	// year certificate signed directly using the contents of
	// trusted_cert_?(key_)file will be created.
	ServerCertFile string `protobuf:"bytes,5,opt,name=server_cert_file,json=serverCertFile,proto3" json:"server_cert_file,omitempty"`
	// A file containing the private key associated with
	// server_cert_file. Required.
	//
	// NOTE: Contains private key material.
	ServerCertKeyFile string `protobuf:"bytes,6,opt,name=server_cert_key_file,json=serverCertKeyFile,proto3" json:"server_cert_key_file,omitempty"`
	// Where to write the fleetspeak server component configuration file.
	//
	// NOTE: Result will contain private key material. Will only be needed by
	// fleetspeak servers.
	ServerComponentConfigurationFile string `` /* 161-byte string literal not displayed */
	// How clients should find the fleetspeak server(s) used by this installation.
	//
	// Each entry should be of the form "<ip/hostname>:<port>". Note the clients
	// will not perform any intelligent load balancing, rather they will continue
	// to use the first option which works for them.
	//
	// If you are creating your own server certificates, they will need to cover
	// these addresses.
	PublicHostPort []string `protobuf:"bytes,8,rep,name=public_host_port,json=publicHostPort,proto3" json:"public_host_port,omitempty"`
	// If set, write a linux client configuration file for this installation.
	LinuxClientConfigurationFile string `` /* 149-byte string literal not displayed */
	// If set, write a linux client configuration file for this installation.
	DarwinClientConfigurationFile string `` /* 153-byte string literal not displayed */
	// If set, write a linux client configuration file for this installation.
	WindowsClientConfigurationFile string `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

The configuration parameters needed by the configuration tool in order to create the artifacts needed to run a fleetspeak installation.

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetComponentsConfig

func (x *Config) GetComponentsConfig() *fleetspeak_components.Config

func (*Config) GetConfigurationName

func (x *Config) GetConfigurationName() string

func (*Config) GetDarwinClientConfigurationFile

func (x *Config) GetDarwinClientConfigurationFile() string

func (*Config) GetLinuxClientConfigurationFile

func (x *Config) GetLinuxClientConfigurationFile() string

func (*Config) GetPublicHostPort

func (x *Config) GetPublicHostPort() []string

func (*Config) GetServerCertFile

func (x *Config) GetServerCertFile() string

func (*Config) GetServerCertKeyFile

func (x *Config) GetServerCertKeyFile() string

func (*Config) GetServerComponentConfigurationFile

func (x *Config) GetServerComponentConfigurationFile() string

func (*Config) GetTrustedCertFile

func (x *Config) GetTrustedCertFile() string

func (*Config) GetTrustedCertKeyFile

func (x *Config) GetTrustedCertKeyFile() string

func (*Config) GetWindowsClientConfigurationFile

func (x *Config) GetWindowsClientConfigurationFile() string

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string