README
¶
etcd Tools
A set of tools used by Freifunk Braunschweig to interact with an etcd Key Value store.
This includes:
- etcdconfigweb (Godoc) to provide a HTTP server for querying node configurations and inserting new nodes into etcd.
- concentratorconfig (Godoc) retrieves the list of nodes from the etcd and updates the wireguard interface accordingly.
- etcdutility (Godoc) is a command line utility with specialized functions for the FFBS etcd instance.
- webutility (Godoc) is an basic client to interact with etcdconfigweb for debugging purposes.
Installing
go install gitli.stratum0.org/ffbs/etcd-tools/...@latest
This installs all tools to the path of the GOBIN environment variable (by default ~/go/bin). By default Go uses a proxy for faster downloads and retaining the sources even when the Git-Repository goes down. The default proxy is https://proxy.golang.org and can be changed via the GOPROXY environment variable (the value direct disables the usage of a proxy).
Directories
¶
| Path | Synopsis |
|---|---|
|
concentratorconfig configures the Wireguard interface based on the etcd KV configuration.
|
concentratorconfig configures the Wireguard interface based on the etcd KV configuration. |
|
etcdconfigweb provides an http interface to query and register nodes from the etcd KV store.
|
etcdconfigweb provides an http interface to query and register nodes from the etcd KV store. |
|
Package etcdhelper implements marshaling whole etcd prefixes from and to go values.
|
Package etcdhelper implements marshaling whole etcd prefixes from and to go values. |
|
Utility for the ffbs etcd.
|
Utility for the ffbs etcd. |
|
Freifunk Braunschweig specific structures and helper functionality
|
Freifunk Braunschweig specific structures and helper functionality |
|
Utility to query the /config HTTP endpoint of gitli.stratum0.org/ffbs/etcd-tools/etcconfigweb and validate the response signature.
|
Utility to query the /config HTTP endpoint of gitli.stratum0.org/ffbs/etcd-tools/etcconfigweb and validate the response signature. |
Click to show internal directories.
Click to hide internal directories.