Updated README.md

This commit is contained in:
David J. Allen 2024-04-11 10:17:03 -06:00
parent ed7fcbc151
commit 112db14dd4
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC

View file

@ -4,10 +4,12 @@ Configurator is a tool that fetchs data from an instance of [SMD](https://github
## Building and Usage
Configurator is built using Go:
Configurator is built using standard `go` build tools. The project separates the client and server with build tags. To get started, clone the project, download the dependencies, and build the project:
```bash
go mod tidy && go build
git clone https://github.com/OpenCHAMI/configurator.git
go mod tidy
go build --tags all # equivalent to `go build --tags client,server``
```
To use the tool, run the following:
@ -18,6 +20,20 @@ To use the tool, run the following:
This will generate a new DHCP `dnsmasq` config file based on the Jinja 2 template specified in the config file for "dnsmasq". The `--target` flag is set by passing an argument in the form of "type:template" to specify the type of config file being generate and the template file to use respectively. The configurator requires valid access token when making requests to an instance of SMD that has protected routes.
The tool can also be ran as a microservice:
```bash
./configurator serve --config config.yaml
```
Once the server is up and listening for HTTP requests, you can try making a request to it with curl:
```bash
curl http://127.0.0.1:3334/target?type=dhcp&template=dnsmasq
```
This will do the same thing as the `generate` subcommand, but remotely.
## Configuration
Here is an example config file to start using configurator:
@ -31,9 +47,9 @@ templates:
coredhcp: templates/dhcp/coredhcp.config.jinja
dnsmasq: templates/dhcp/dnsmasq.conf.jinja
syslog: templates/syslog.jinja
ansible: templates/ansible
powerman: templates/powerman
conman: templates/conman
ansible: templates/ansible.j2
powerman: templates/powerman.jinja
conman: templates/conman.jinja
```