forked from vieter-v/vieter
docs(agent): added agent configuration docs
parent
d3151863ee
commit
8a2f720bdf
|
@ -17,7 +17,7 @@ If a variable is both present in the config file & as an environment variable,
|
|||
the value in the environment variable is used.
|
||||
|
||||
{{< hint info >}}
|
||||
**Note**
|
||||
**Note**
|
||||
All environment variables can also be provided from a file by appending them
|
||||
with `_FILE`. This for example allows you to provide the API key from a Docker
|
||||
secrets file.
|
||||
|
@ -97,3 +97,25 @@ configuration variable required for each command.
|
|||
build`.
|
||||
* Default: `archlinux:base-devel`
|
||||
|
||||
### `vieter agent`
|
||||
|
||||
* `log_level`: log verbosity level. Value should be one of `FATAL`, `ERROR`,
|
||||
`WARN`, `INFO` or `DEBUG`.
|
||||
* Default: `WARN`
|
||||
* `address`: *public* URL of the Vieter repository server to build for. From
|
||||
this server jobs are retrieved. All built packages are published to this
|
||||
server.
|
||||
* `api_key`: API key of the above server.
|
||||
* `data_dir`: directory to store log file in.
|
||||
* `max_concurrent_builds`: how many builds to run at the same time.
|
||||
* Default: `1`
|
||||
* `polling_frequency`: how often (in seconds) to poll the server for new
|
||||
builds. Note that the agent might poll more frequently when it's actively
|
||||
processing builds.
|
||||
* `image_rebuild_frequency`: Vieter periodically builds images that are then
|
||||
used as a basis for running build containers. This is to prevent each build
|
||||
from downloading an entire repository worth of dependencies. This setting
|
||||
defines how frequently (in minutes) to rebuild these images.
|
||||
* Default: `1440` (every 24 hours)
|
||||
* `arch`: architecture for which this agent should pull down builds (e.g.
|
||||
`x86_64`)
|
||||
|
|
|
@ -21,7 +21,7 @@ branch. This branch will be the most up to date, but does not give any
|
|||
guarantees about stability, so beware!
|
||||
|
||||
Thanks to the single-binary design of Vieter, this image can be used both for
|
||||
the repository server & the cron daemon.
|
||||
the repository server, the cron daemon and the agent.
|
||||
|
||||
Below is an example compose file to set up both the repository server & the
|
||||
cron daemon:
|
||||
|
@ -76,7 +76,7 @@ architectures will build on both.
|
|||
## Binary
|
||||
|
||||
On the
|
||||
[releases](https://git.rustybever.be/vieter/vieter/releases)
|
||||
[releases](https://git.rustybever.be/vieter-v/vieter/releases)
|
||||
page, you can find statically compiled binaries for all
|
||||
released versions. This is the same binary as used inside
|
||||
the Docker images.
|
||||
|
@ -106,5 +106,5 @@ guarantee that a compiler update won't temporarily break them.
|
|||
|
||||
## Building from source
|
||||
|
||||
The project [README](https://git.rustybever.be/vieter/vieter#building) contains
|
||||
instructions for building Vieter from source.
|
||||
The project [README](https://git.rustybever.be/vieter-v/vieter#building)
|
||||
contains instructions for building Vieter from source.
|
||||
|
|
|
@ -37,6 +37,6 @@ Each section can consist of as many of these parts as necessary.
|
|||
## CLI tool
|
||||
|
||||
The Vieter binary contains a command that shows you the next matching times for
|
||||
a given expression. This can be useful to understand the syntax. For more
|
||||
a given expression. This can be useful for understanding the syntax. For more
|
||||
information, see
|
||||
[vieter-schedule(1)](https://rustybever.be/man/vieter/vieter-schedule.1.html).
|
||||
|
|
|
@ -32,7 +32,7 @@ fn agent_init(logger log.Log, conf Config) AgentDaemon {
|
|||
logger: logger
|
||||
client: client.new(conf.address, conf.api_key)
|
||||
conf: conf
|
||||
images: new_image_manager(conf.image_rebuild_frequency)
|
||||
images: new_image_manager(conf.image_rebuild_frequency * 60)
|
||||
builds: []BuildConfig{len: conf.max_concurrent_builds}
|
||||
atomics: []u64{len: conf.max_concurrent_builds}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue