package
0.28.3
Repository: https://github.com/mudler/edgevpn.git
Documentation: pkg.go.dev

# Functions

NewClient returns a new client with an associated service ID.
NewNode returns a new service Node The service Node can have role applied which are polled by the API.
NewProcessController returns a new process controller associated with the state directory.
WithAPIAddress sets the EdgeVPN API address.
WithAssets is a list of assets to copy to a temporary state dir from the embedded FS It is used in conjunction with WithFS to ease out binary embedding.
WithClient sets a service client.
WithDefaultRoles allows to set a list of comma separated roles prefixed for the node.
WithFS accepts an embed.FS file system where to copy binaries from.
WithLogger defines a logger to be used across the whole execution.
No description provided by the author
WithNetworkToken allows to set a network token.
WithPersistentRoles allows to set a list of comma separated roles that can is applied persistently.
WithRole sets the available roles.
WithRoleAPIAddress sets the API Address used during the execution.
WithRoleClient sets a client for a role.
WithRoleLogger sets a logger for the role action.
WithRoles defines a set of role keys.
WithRoleServiceID sets a role service ID.
WithRoleStateDir sets the statedir for the role.
WithRoleToken sets the network token which can be used by the role.
WithRoleUUID sets the UUID which performs the role.
WithStateDir sets the node state directory.
WithStopRoles allows to set a list of comma separated roles that can be applied during cleanup.
WithTokenfile sets a token file.
WithUUID sets a node UUID.

# Structs

Client is a wrapper of an edgeVPN client with additional metadata and syntax sugar.
Node is the service Node.
ProcessController syntax sugar around go-processmanager.
RoleConfig is the role config structure, which holds all the objects that can be used by a Role.
RoleKey is an association between a Role(string) and a Handler which actually fullfills the role.

# Type aliases

Option is a Node option.
Role is a service role.
RoleOption is a role option.