Configuring Remediate
After installing Puppet Remediate, configure and administer the application by using the command line interface (CLI).
Command line options
The CLI provides additional administrative and troubleshooting options beyond the user interface.
docker-compose run remediate [command]
Command | Description |
---|---|
config | View and modify the
configuration. Usage:
The following commands are used with the config command:
|
config get-compose-file | Gets the docker compose
file. Usage:
In addition to the available global flags, you can use the following flag with the config get-compose-file command:
|
config set-override | Set configuration override for Puppet Remediate (requires
restart). Usage:
See Configuration overrides below for more information about how to use this command. |
config unset-override | Unset configuration override for Puppet Remediate (requires
restart). Usage:
See Configuration overrides below for more information about how to use this command. |
config view | View configuration for Puppet Remediate. Usage:
|
export | Export the Remediate images to a
tar
file. Usage:
|
generate-docs | Generates the CLI documentation. Markdown files are created at the specified path detailing the CLI commands. Usage:
|
help | Displays the help
commands. Usage:
|
import | Import the Remediate images from a
tar
file. Usage:
In addition to the available global flags, you can use the following flag with the import command:
|
logs | Displays the application service
logs. Usage:
In addition to the available global flags, you can use the following flags with the logs command:
|
mayday | Creates a mayday tarball containing debug information for
troubleshooting with the Puppet
support
team. Usage:
In addition to the available global flags, you can use the following flag with the mayday command:
|
reset | Deletes sources, credentials, user passwords, and resets the
application to an uninstalled
state. Usage:
In addition to the available global flags, you can use the following flag with the reset command:
|
restart | Restarts the
application. Usage:
In addition to the available global flags, you can use the following flag with the restart command:
|
set-admin-password | Updates the current admin
password. Usage:
|
set-viewer-password | Updates the current viewer
password. Usage:
|
set-license | Sets a new license.
Usage:
In addition to the available global flags, you can use the following flag with the set-license command:
|
start | Initializes and starts the
application. Usage:
In addition to the available global flags, you can use the following flags with the start command:
|
stop | Stops the
application. Usage:
In addition to the available global flags, you can use the following flag with the stop command:
|
update | Updates to the latest version.
Usage:
In addition to the available global flags, you can use the following flags with the update command:
The update command also be used with the list sub-command or with its own local flags. |
update list | Shows a list of available
versions. Usage:
|
Global flags
In addition to the flags that can be used with individual commands, the following flags can be used with all commands:
Flag | Description |
---|---|
--config string | Config file (default is $HOME/.installer.yaml) (default ".installer.yml") |
-h, --help |
Help for remediate Use remediate [command] --help to get more information about a command. |
Configuration overrides
After installing Remediate, optimize the application for your environment by configuring and tuning settings as needed.
To view the current configuration:
docker-compose run remediate config view
To override a configuration key:
docker-compose run remediate config set-override [key] [value]
To reset a configuration key:
docker-compose run remediate config unset-override [key] [value]
Key | Description | Default value |
---|---|---|
controller.DiscoveryInterval | The interval between each discovery run. | every 4h |
controller.loglevel | The logging levels for the controller container. |
INFO (default) DEBUG WARN ERROR FATAL PANIC |
edge.discoworkers | The maximum number of discovery processes that run in parallel. | 512 |
edge.taskworkers | The maximum number of tasks that run in parallel. | 32 |
edge.workertimeout | The time out value, in minutes, for each job. | 25 |
edge.loglevel | The logging levels for the edge container. |
WARN (default) INFO DEBUG ERROR FATAL PANIC |
ingress.ipv6enabled | Enable IPv6 on ingress. | true |
pdp.tll | The interval, in minutes, that checks are made for resources older than the (time-to-live) TLL interval. | 60 |
pdp.tllWindow | The TLL interval before resources are deleted. | 12h |