README
¶
metis-pkg
This is the core Go codebase of Metis, imported by the Metis Go code as well local, client-side metis-cli CLI tool.
metis-pkg is specifically designed to be usable by both first-party and third-party applications in the same way you'd be able to use any other Go package.
The Metis server is developed in the primary Metis repository. If you are looking for Metis releases, please consult that repository. metis-pkg goes through its own versioning system separate from the client-side TypeScript and server-side Go code of Metis.
No external packages are currently needed for metis-pkg.
Note: This package has currently only been tested on Linux-based operating systems and may not work yet on others. The plan is testing on Windows and applying appropriate patches where necessary.
Contributing
This project leverages CodeUtils for development and adopts the CodeUtils Usage Spec. To learn how to contribute to this project and set up CodeUtils, read here.
You have two supported options for obtaining this package:
- You can get the latest codebase by using
go get github.com/StroblIndustries/metis-pkg - You can download our latest 0.4.1 stable version
Compiling is done via CodeUtils' Compiler. More information linked in the Spec above.
Usage
Usage information is currently not available however will be documented and published on Strobl Industries' Developer Center around the time of the Metis 2.0 release.
Documentation
¶
Index ¶
- Variables
- func Configure(providedConfig ConfigOptions)
- func Decode(bytes []byte) (map[string]interface{}, error)
- func Delete(nodes []string, files []string) map[string]interface{}
- func Initialize(nodeListFileContent []byte) bool
- func IoLogic(fileInputChan chan map[string]interface{}, action string, node Node, ...)
- func IsClusterReachable(clusterLocation string) bool
- func IsDir(path string, createDir bool) bool
- func IsLocalNode(node Node) bool
- func Manage(action string, nodes []string, providedFiles interface{}, content interface{}) map[string]interface{}
- func MessageLogger(syslogType syslog.Priority, message string)
- func ObjectMerger(currentContent, newContent map[string]interface{}) map[string]interface{}
- func Read(nodes []string, files []string) map[string]interface{}
- func Request(fileInputChan chan map[string]interface{}, action string, node Node, ...)
- func Update(nodes []string, files []string, content interface{}) map[string]interface{}
- func Write(nodes []string, files []string, content interface{}) map[string]interface{}
- type ConfigOptions
- type Node
- type NodeGroup
Constants ¶
This section is empty.
Variables ¶
var NodeList map[string]interface{}
NodeList is a List of Nodes or Node Grtoups
Functions ¶
func Configure ¶
func Configure(providedConfig ConfigOptions)
Configure is used to configure the metis-pkg
func Decode ¶
Decode is responsible for taking []byte, decoding, and returning a map[string]interface{} and/or decode error
func Initialize ¶
Initialize will initialize the metis with the contents of a NodeList
func IoLogic ¶
func IoLogic(fileInputChan chan map[string]interface{}, action string, node Node, file string, content interface{})
IoLogic is responsible for handling local file IO, triggered via Manage()
func IsClusterReachable ¶
IsClusterReachable will ping the Cluster to confirm if we can connect
func IsLocalNode ¶
IsLocalNode checks if the provided Node is local or remote
func Manage ¶
func Manage(action string, nodes []string, providedFiles interface{}, content interface{}) map[string]interface{}
Manage handles channeling, local / remote IO differentiation, etc.
func MessageLogger ¶
MessageLogger log a message to system log
func ObjectMerger ¶
ObjectMerger will merge two objects
func Request ¶
func Request(fileInputChan chan map[string]interface{}, action string, node Node, files []string, content interface{})
Request handles API requests to another remote Metis cluster.
Types ¶
type ConfigOptions ¶
type ConfigOptions struct {
DataRootDirectory string // Directory where data is stored
}
ConfigOptions is a struct of available configuration options for metis
var Config ConfigOptions
Config is the configuration of metis
type Node ¶
type Node struct {
Folder, Address, ExternalNodes string
}
Node is a struct with information on a Metis Node
func ConvertToNode ¶
ConvertToNode will attempt to convert interface{} to Node
Source Files