Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cleanup conf and man pages #235

Merged
merged 1 commit into from
Apr 13, 2023
Merged

Cleanup conf and man pages #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions config/agent/agent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,29 @@ NodeName=

#
# The IP address that hirte-agent can use to connect to hirte manager. It must be a valid IPv4 or IPv6 address.
# It's mandatory to set either ManagerHost or ManagerAddress option for each hirte-agent.
# One of the ManagerHost or ManagerAddress options must be set for each hirte-agent.
ManagerHost=
ygalblum marked this conversation as resolved.
Show resolved Hide resolved

#
# The port the manager listens on to establish connections with the hirte
# agents.
# The port the manager listens on to establish connections with the hirte agents.
#ManagerPort=842

#
# SD Bus address used by hirte-agent to connect to hirte. See `man sd_bus_set_address` for its format.
# Overrides any setting of ManagerHost or ManagerPort defined in the configuration file as well as the respective
# CLI options.
# The ManagerAddress overrides any setting of ManagerHost or ManagerPort defined in the configuration file as well as
# the respective CLI options.
#ManagerAddress=

#
# Defines the interval between two heartbeat signals sent to hirte in milliseconds.
#HeartbeatInterval=
# Defines the interval between two heartbeat signals sent to hirte in milliseconds.
#HeartbeatInterval=2000

#
# The level used for logging. Supported values are: DEBUG, INFO, WARN and ERROR.
#LogLevel=INFO

#
# The target where logs are written to. Supported values are: journald and
# stderr.
# The target where logs are written to. Supported values are: journald and stderr.
#LogTarget=journald

#
Expand Down
10 changes: 4 additions & 6 deletions config/hirte/hirte.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,21 @@
[hirte]

#
# A comma separated list of unique hirte-agent names. Only nodes with names mentioned in the list can connect to
# hirte manager. These names are defined in the agent's configuration file under `NodeName` option
# A comma separated list of unique hirte-agent names. Only nodes with names mentioned in the list can connect to hirte
# manager. These names are defined in the agent's configuration file under the `NodeName` option.
# (see `hirte-agent.conf(5)`).
AllowedNodeNames=

#
# The port the manager listens on to establish connections with the hirte
# agents.
# The port the manager listens on to establish connections with the hirte agents.
#ManagerPort=842

#
# The level used for logging. Supported values are: DEBUG, INFO, WARN and ERROR.
#LogLevel=INFO

#
# The target where logs are written to. Supported values are: journald and
# stderr.
# The target where logs are written to. Supported values are: journald and stderr.
#LogTarget=journald

#
Expand Down
4 changes: 2 additions & 2 deletions doc/man/hirte-agent.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The host used by `hirte-agent` to connect to `hirte`. Must be a valid IPv4 or IP

#### **--port**, **-p**

The port on which `hirte` is listening for connection request and the `hirte-agent` is connecting to. This option will overwrite the port defined in the configuration file.
The port on which `hirte` is listening for connection request and the `hirte-agent` is connecting to. This option will overwrite the port defined in the configuration file. (default: 842)

#### **--address**, **-a**

Expand All @@ -45,7 +45,7 @@ The interval between two heartbeat signals sent to hirte in milliseconds. This o

#### **--config**, **-c**

Path to the configuration file, see `hirte-agent.conf(5)`.
Path to the configuration file, see `hirte-agent.conf(5)`. (default: /etc/hirte/agent.conf)

#### **--user**

Expand Down
3 changes: 3 additions & 0 deletions doc/man/hirte-agent.conf.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ LogLevel=DEBUG
LogTarget=journald
LogIsQuiet=false
```
## FILES

Distributions provide the __/usr/share/hirte-agent/config/hirte-default.conf__ file which defines hirte-agent configuration defaults. Administrators can copy this file to __/etc/hirte/agent.conf__ and specify their own configuration.

## SEE ALSO

Expand Down