Documentation
¶
Index ¶
- Constants
- Variables
- func ClusterDefinition() parser.NamedBlockDefinition
- func DatabaseDefinition() parser.NamedBlockDefinition
- func DeveloperDefinition() parser.NamedBlockDefinition
- func EncryptionKeyDefinition() parser.NamedBlockDefinition
- func EventsDefinition() parser.NamedBlockDefinition
- func NewContext() *hcl.EvalContext
- func Schema() parser.NamedBlockDefinitions
- func VariablesDefinition() parser.NamedBlockDefinition
- type IPGetter
- type InterfaceIPGetter
- type PrivateIPGetter
- type PublicIPGetter
Constants ¶
const ( // encoding problems DiagEncryptionKeyEncoding = "The encryption key provided is not base64 encoded" DiagEncryptionKeyEncodingDetail = "Encryption keys must be base64 encoded to prevent the need for escaping when passing the key in via" + "environment variables and/or config files." // length problems DiagEncryptionKeyBelowLength = "The encryption key provided is less than 32 bytes in length" DiagEncryptionKeyAboveLength = "The encryption key provided is more than 32 bytes in length" DiagEncryptionKeyLengthDetail = "Encryption keys must be exactly 32 bytes in length to enable the encryption algorithm. You can use" + "the 'response keygen' command to generate a suitable encryption key." // Bytes required for AES 256-bit encryption algorithm EncryptionByteRequirement = 32 )
Problem messages, use for comparison if necessary.
const (
DiagUnsupportedAutoJoinType = "Unsupported cluster auto-join type"
)
Public diagnostic summaries
const (
DiagUnsupportedDatabaseDriver = "Unsupported database driver"
)
Public diagnostic summaries
Variables ¶
var ( // Diagnostic messages regarding an invalid message bus implementation type DiagInvalidPubSubType = "The events type is not valid" DiagInvalidPubSubTypeDetail = "The events type must be one of: embedded, nats" DiagNATSRequiresURL = "The 'nats' events type requires a URL." DiagNatsRequiresURLDetail = "You must provide the 'url' attribute when using the 'nats' pubsub type." )
Diag messages
Functions ¶
func ClusterDefinition ¶
func ClusterDefinition() parser.NamedBlockDefinition
func DatabaseDefinition ¶
func DatabaseDefinition() parser.NamedBlockDefinition
DatabaseDefinition allows registration of the database block using NewWithSubset.
func DeveloperDefinition ¶
func DeveloperDefinition() parser.NamedBlockDefinition
func EncryptionKeyDefinition ¶
func EncryptionKeyDefinition() parser.NamedBlockDefinition
EncryptionKeyDefinition allows registration of the encryption_key definition block using NewWithSubset.
func EventsDefinition ¶
func EventsDefinition() parser.NamedBlockDefinition
EventsDefinition allows registration of the events block using NewWithSubset.
func NewContext ¶
func NewContext() *hcl.EvalContext
NewContext creates a new hcl.EvalContext and returns the pointer to be used with the schema. This allows the caller to automatically insert expected functions and variables.
func Schema ¶
func Schema() parser.NamedBlockDefinitions
Schema defines the blocks and their respecify BlockDefinition by creating an instance of parser.BlockDefinitions.
func VariablesDefinition ¶
func VariablesDefinition() parser.NamedBlockDefinition
VariablesDefinition allows registration of the vars definition block using NewWithSubset.
Types ¶
type IPGetter ¶
type IPGetter struct{}
IPGetter implements the PrivateIPGetter, PublicIPGetter, and InterfaceIPGetter interfaces used by the networking functions to return proper addresses for listener bindings.
func (*IPGetter) GetInterfaceIP ¶
GetInterfaceIP returns a string with a single IP address sorted by the size of the network (i.e. IP addresses with a smaller netmask, larger network size, are sorted first). This function is the `eval` equivalent of:
func (*IPGetter) GetPrivateIP ¶
GetPrivateIP returns a string with a single IP address that is part of RFC 6890 and has a default route. If the system can't determine its IP address or find an RFC 6890 IP address, an empty string will be returned instead.
func (*IPGetter) GetPublicIP ¶
GetPublicIP returns a string with a single IP address that is NOT part of RFC 6890 and has a default route. If the system can't determine its IP address or find a non RFC 6890 IP address, an empty string will be returned instead.
type InterfaceIPGetter ¶
InterfaceIPGetter implements a function that returns the current IP address for the named interface provided.
type PrivateIPGetter ¶
PrivateIPGetter implements a function that returns the current private IP address for the runtime environment.
type PublicIPGetter ¶
PublicIPGetter implements a function that returns the current public IP address for the runtime environment.
Source Files