README
¶
drlm-core v3
drlm-Core v3
Install protoc plugin for GO
$ go get -u google.golang.org/grpc
Install cobra
$ go get -u github.com/spf13/cobra/cobra
$ cat $HOME/.cobra.yaml
author: Pau Roura <pau@brainupdaters.net>
license: AGPL
$ cobra init github.com/brainupdaters/drlm-cli
$ cd github.com/brainupdaters/drlm-cli
$ cobra add newCommand
https://github.com/spf13/cobra/blob/master/cobra/README.md
Install logrus
Logrus is a structured logger for Go (golang), completely API compatible with the standard library logger.
$ go get "github.com/Sirupsen/logrus"
install Protocol Buffers V3
The simplest way to do this is to download pre-compiled binaries for your platform(protoc-<version>-<platform>.zip) from here: https://github.com/google/protobuf/releases
*Unzip this file.
*Update the environment variable PATH to include the path to the protoc binary file.
$ go get -u github.com/golang/protobuf/protoc-gen-go
$ protoc -I drlm-comm/ drlm-comm/drlm-comm.proto --go_out=plugins=grpc:drlm-comm/
etcd
mgmtconfig
sentry
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent has the logic related with the agents.
|
Package agent has the logic related with the agents. |
|
Package auth is the responsible of user authentication and authorization.
|
Package auth is the responsible of user authentication and authorization. |
|
types
Package types has all the different authentication types
|
Package types has all the different authentication types |
|
Package cfg is the responsible of all the configuration stuff of DRLM Core.
|
Package cfg is the responsible of all the configuration stuff of DRLM Core. |
|
Package cli is like the "main" package.
|
Package cli is like the "main" package. |
|
Package cmd is the responsible of parsing the commands flags and initializing the conections with the DB, reading the config...
|
Package cmd is the responsible of parsing the commands flags and initializing the conections with the DB, reading the config... |
|
Package db has the DB connection and connects to it
|
Package db has the DB connection and connects to it |
|
migrations
Package migrations is the responsible of migrating the DB correctly.
|
Package migrations is the responsible of migrating the DB correctly. |
|
Package minio has the connection with Minio, handles the user creation / policies for each agent and creates an space for each job to store data
|
Package minio has the connection with Minio, handles the user creation / policies for each agent and creates an space for each job to store data |
|
Package models has all the type definitions of DRLM Core It's also the responsible of interacting with the DB (e.g.
|
Package models has all the type definitions of DRLM Core It's also the responsible of interacting with the DB (e.g. |
|
Package scheduler is the responsible of managing the jobs queue
|
Package scheduler is the responsible of managing the jobs queue |
|
Package transport is the responsible of the comunication with the clients (web, drlmctl).
|
Package transport is the responsible of the comunication with the clients (web, drlmctl). |
|
grpc
Package grpc is the responsible for implementing the GRPC service defined at github.com/brainupdaters/drlm-common/pkg/proto It basically parses the requests and calls the other packages
|
Package grpc is the responsible for implementing the GRPC service defined at github.com/brainupdaters/drlm-common/pkg/proto It basically parses the requests and calls the other packages |
|
Package utils contains subpackages with utilities of DRLM Core
|
Package utils contains subpackages with utilities of DRLM Core |
|
secret
Package secret is responsible for generating secrets for DRLM Core
|
Package secret is responsible for generating secrets for DRLM Core |
|
tests
Package tests are different utilities used for testing DRLM Core
|
Package tests are different utilities used for testing DRLM Core |