towk/configurator
1
0
Fork 0
mirror of https://github.com/davidallendj/configurator.git synced 2025-12-20 11:37:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
David Allen 2024-07-03 11:40:33 -06:00
parent c59efb835f
commit e15018072f
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC
1 changed files with 24 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -41,12 +41,12 @@ The tool can also run as a service to generate files for clients:
Once the server is up and listening for HTTP requests, you can try making a request to it with `curl` or `configurator fetch`. Both commands below are essentially equivalent: Once the server is up and listening for HTTP requests, you can try making a request to it with `curl` or `configurator fetch`. Both commands below are essentially equivalent:
```bash ```bash
curl http://127.0.0.1:3334/generate?target=dnsmasq curl http://127.0.0.1:3334/generate?target=dnsmasq -H "Authorization: Bearer $ACCESS_TOKEN"
# ...or... # ...or...
./configurator fetch --target dnsmasq --host http://127.0.0.1 --port 3334 ./configurator fetch --target dnsmasq --host http://127.0.0.1 --port 3334
``` ```
This will do the same thing as the `generate` subcommand, but remotely. This will do the same thing as the `generate` subcommand, but remotely. The access token is only required if the `CONFIGURATOR_JWKS_URL` environment variable is set. The `ACCESS_TOKEN` environment variable passed to `curl` and it's corresponding CLI argument both expects a token as a JWT.
### Creating Generator Plugins ### Creating Generator Plugins
@ -118,31 +118,34 @@ Now your plugin should be available to use with the `configurator` main driver.
Here is an example config file to start using configurator: Here is an example config file to start using configurator:
```yaml ```yaml
server: # server settings when using as service server: # Server-related parameters when using as service
host: 127.0.0.1 host: 127.0.0.1
port: 3334 port: 3334
jwks: # set URL for JWKS to enable auth jwks: # Set the JWKS uri to protect /generate route
uri: "" uri: ""
retries: 5 retries: 5
smd: # settings for SMD service smd: . # SMD-related parameters
host: http://127.0.0.1 host: http://127.0.0.1
port: 27779 port: 27779
templates: # template mappings to generator plugins (by name) plugins: # path to plugin directories
dnsmasq: templates/dnsmasq.jinja
coredhcp: templates/coredhcp.jinja
syslog: templates/syslog.jinja
ansible: templates/ansible.jinja
powerman: templates/powerman.jinja
conman: templates/conman.jinja
groups: # (WIP) setting to allow creating configs by groups
warewulf:
- dnsmasq
- syslog
- ansible
- powerman
- conman
plugins: # path to plugin directories (may change to include files as well)
- "lib/" - "lib/"
targets: # targets to call with --target flag
dnsmasq:
templates:
- templates/dnsmasq.jinja
warewulf:
templates: # files using Jinja templating
- templates/warewulf/vnfs/dhcpd-template.jinja
- templates/warewulf/vnfs/dnsmasq-template.jinja
files: # files to be copied without templating
- templates/warewulf/defaults/provision.jinja
- templates/warewulf/defaults/node.jinja
- templates/warewulf/filesystem/examples/*
- templates/warewulf/vnfs/*
- templates/warewulf/bootstrap.jinja
- templates/warewulf/database.jinja
targets: # additional targets to run
- dnsmasq
``` ```
The `server` section sets the properties for running the `configurator` tool as a service and is not required if you're only using the CLI. Also note that the `jwks-uri` parameter is only needs for protecting endpoints. If it is not set, then the API is entirely public. The `smd` section tells the `configurator` tool where to find SMD to pull state management data used by the internal client. The `templates` section is where the paths are mapped to each generator plugin by its name (see the [`Creating Generator Plugins`](#creating-generator-plugins) section for details). The `plugins` is a list of paths to load generator plugins. The `server` section sets the properties for running the `configurator` tool as a service and is not required if you're only using the CLI. Also note that the `jwks-uri` parameter is only needs for protecting endpoints. If it is not set, then the API is entirely public. The `smd` section tells the `configurator` tool where to find SMD to pull state management data used by the internal client. The `templates` section is where the paths are mapped to each generator plugin by its name (see the [`Creating Generator Plugins`](#creating-generator-plugins) section for details). The `plugins` is a list of paths to load generator plugins.