Documentation
¶
Index ¶
- Constants
- Variables
- func HasTLS() bool
- func MaxBrokerClients() int
- func ProvisionDefault() bool
- func ProvisionSecurity() bool
- type Info
- func (i *Info) AgentProviders() []string
- func (i *Info) BuildDate() string
- func (i *Info) ClientIdentitySuffix() string
- func (i *Info) DataProviders() []string
- func (i *Info) DefaultCollectives() []string
- func (i *Info) DisableProvisionModeAsDefault()
- func (i *Info) DisableProvisionModeSecurity()
- func (i *Info) EnableProvisionModeAsDefault()
- func (i *Info) EnableProvisionModeSecurity()
- func (i *Info) HasTLS() bool
- func (i *Info) License() string
- func (i *Info) MachineWatchers() []string
- func (i *Info) Machines() []string
- func (i *Info) MaxBrokerClients() int
- func (i *Info) ProvisionAgent() bool
- func (i *Info) ProvisionAllowServerUpdate() bool
- func (i *Info) ProvisionBrokerSRVDomain() string
- func (i *Info) ProvisionBrokerURLs() string
- func (i *Info) ProvisionDefault() bool
- func (i *Info) ProvisionFacts() string
- func (i *Info) ProvisionJWTFile() string
- func (i *Info) ProvisionRegistrationData() string
- func (i *Info) ProvisionSecurity() bool
- func (i *Info) ProvisionStatusFile() string
- func (i *Info) ProvisionToken() string
- func (i *Info) ProvisionUsingVersion2() bool
- func (i *Info) ProvisioningBrokerPassword() string
- func (i *Info) ProvisioningBrokerUsername() string
- func (i *Info) RegisterAgentProvider(p string)
- func (i *Info) RegisterDataProvider(p string)
- func (i *Info) RegisterMachine(p string)
- func (i *Info) RegisterMachineWatcher(p string)
- func (i *Info) SHA() string
- func (i *Info) SetProvisionAllowServerUpdate(allow bool)
- func (i *Info) SetProvisionBrokerSRVDomain(d string)
- func (i *Info) SetProvisionBrokerURLs(u string)
- func (i *Info) SetProvisionFacts(f string)
- func (i *Info) SetProvisionJWTFile(t string)
- func (i *Info) SetProvisionRegistrationData(f string)
- func (i *Info) SetProvisionToken(t string)
- func (i *Info) SetProvisionUsingVersion2(v2 bool)
- func (i *Info) SetProvisioningBrokerPassword(p string)
- func (i *Info) SetProvisioningBrokerUsername(u string)
- func (i *Info) SupportsProvisioning() bool
- func (i *Info) Version() string
Constants ¶
const License = "Apache-2.0"
License is the official Open Source Initiative license abbreviation
Variables ¶
var AgentProviders = []string{}
AgentProviders are registered systems capable of extending choria with new agents
var BuildDate = "unknown"
BuildDate is when it was build
var ClientIdentitySuffix = "mcollective"
ClientIdentitySuffix is the string to be suffixed when creating client identities
var DataProviders = []string{}
DataProviders are registered Data plugins
var DefaultCollectives = "mcollective"
DefaultCollectives is the names of the default list of collectives as comma separated strings
var MachineWatchers = []string{}
MachineWatchers are registered Autonomous Agent watchers
var Machines = []string{}
Machines are registered Autonomous Agents
var ProvisionAgent = "true"
ProvisionAgent determines if the supplied provisioning agent should be started this lets you programmatically or via the additional agents system supply your own agent to perform the provisioning duties
var ProvisionAllowServerUpdate = "false"
ProvisionAllowServerUpdate allows over the air updates of the choria version from provisioner
var ProvisionBrokerSRVDomain = ""
ProvisionBrokerSRVDomain defines a domain to query for provisioning brokers
var ProvisionBrokerURLs = ""
ProvisionBrokerURLs defines where the daemon will connect when choria.server.provision is true
var ProvisionFacts = ""
ProvisionFacts is a facts file to use for discovery purposes during provisioning mode
var ProvisionJWTFile = ""
ProvisionJWTFile is a file holding a JWT identifying the node to the provisioner
var ProvisionModeDefault = "false"
ProvisionModeDefault defines the value of plugin.choria.server.provision when it's not set in the configuration file at all.
var ProvisionRegistrationData = ""
ProvisionRegistrationData is a file that will be published by the registration system
var ProvisionSecure = "true"
ProvisionSecure when "false" will disable TLS provisioning mode
var ProvisionStatusFile = ""
ProvisionStatusFile is the file where server status will be written to while in provisioning mode
var ProvisionToken = ""
ProvisionToken when not empty this token will be required interact with the provisioner agent
var ProvisioningBrokerPassword = ""
ProvisioningBrokerPassword is the password used to connect to the middleware with
var ProvisioningBrokerUsername = ""
ProvisioningBrokerUsername is the username used to connect to the middleware with
var ProvisioningUsesProtocolV2 = "false"
ProvisioningUsesProtocolV2 indicates if provisioning should use v2 protocol
var SHA = "unknown"
SHA is the git reference used to build this package
var TLS = "true"
TLS controls the NATS protocol level TLS
var Version = "0.28.0"
Version the application version
Functions ¶
func MaxBrokerClients ¶
func MaxBrokerClients() int
MaxBrokerClients is the maximum number of clients the network broker may handle
func ProvisionDefault ¶
func ProvisionDefault() bool
ProvisionDefault defines the value of plugin.choria.server.provision when it's not set in the configuration file at all.
func ProvisionSecurity ¶
func ProvisionSecurity() bool
ProvisionSecurity determines if TLS should be enabled during provisioning
Types ¶
type Info ¶
type Info struct{}
func (*Info) AgentProviders ¶
func (*Info) ClientIdentitySuffix ¶ added in v0.23.0
func (*Info) DataProviders ¶ added in v0.20.0
func (*Info) DefaultCollectives ¶ added in v0.23.0
func (*Info) DisableProvisionModeAsDefault ¶ added in v0.14.0
func (i *Info) DisableProvisionModeAsDefault()
func (*Info) DisableProvisionModeSecurity ¶ added in v0.14.0
func (i *Info) DisableProvisionModeSecurity()
func (*Info) EnableProvisionModeAsDefault ¶ added in v0.14.0
func (i *Info) EnableProvisionModeAsDefault()
func (*Info) EnableProvisionModeSecurity ¶ added in v0.14.0
func (i *Info) EnableProvisionModeSecurity()
func (*Info) MachineWatchers ¶ added in v0.19.0
func (*Info) MaxBrokerClients ¶
func (*Info) ProvisionAgent ¶
func (*Info) ProvisionAllowServerUpdate ¶ added in v0.27.0
func (*Info) ProvisionBrokerSRVDomain ¶ added in v0.13.0
func (*Info) ProvisionBrokerURLs ¶
func (*Info) ProvisionDefault ¶
func (*Info) ProvisionFacts ¶
func (*Info) ProvisionJWTFile ¶ added in v0.13.0
func (*Info) ProvisionRegistrationData ¶
func (*Info) ProvisionSecurity ¶
func (*Info) ProvisionStatusFile ¶
func (*Info) ProvisionToken ¶
func (*Info) ProvisionUsingVersion2 ¶ added in v0.27.0
func (*Info) ProvisioningBrokerPassword ¶ added in v0.15.0
func (*Info) ProvisioningBrokerUsername ¶ added in v0.15.0
func (*Info) RegisterAgentProvider ¶ added in v0.14.0
func (*Info) RegisterDataProvider ¶ added in v0.20.0
func (*Info) RegisterMachine ¶ added in v0.24.0
func (*Info) RegisterMachineWatcher ¶ added in v0.19.0
func (*Info) SetProvisionAllowServerUpdate ¶ added in v0.27.0
func (*Info) SetProvisionBrokerSRVDomain ¶ added in v0.14.0
func (*Info) SetProvisionBrokerURLs ¶ added in v0.14.0
func (*Info) SetProvisionFacts ¶ added in v0.14.0
func (*Info) SetProvisionJWTFile ¶ added in v0.16.0
func (*Info) SetProvisionRegistrationData ¶ added in v0.14.0
func (*Info) SetProvisionToken ¶ added in v0.14.0
func (*Info) SetProvisionUsingVersion2 ¶ added in v0.27.0
func (*Info) SetProvisioningBrokerPassword ¶ added in v0.15.0
func (*Info) SetProvisioningBrokerUsername ¶ added in v0.15.0
func (*Info) SupportsProvisioning ¶ added in v0.23.0
SupportsProvisioning determines if the build supports provisioning, typically that comes down to if a Provisioning Token is set either at build time or through the JWT
Source Files