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:

docker-compose run remediate config [command]

The following commands are used with the config command:

  • get-compose-file
  • set-override
  • unset-override
  • view
config get-compose-file Gets the docker compose file.

Usage:

docker-compose run remediate config get-compose-file [flags]

In addition to the available global flags, you can use the following flag with the config get-compose-file command:

  • --filename string - The filename to output the docker compose file to. (default: remediate-docker-compose.yml).
config set-override Set configuration override for Remediate (requires restart).

Usage:

docker-compose run remediate config set-override [key] [value] [flags]

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:

docker-compose run remediate config unset-override [key]

See Configuration overrides below for more information about how to use this command.
config view View configuration for Remediate.

Usage:

docker-compose run remediate config view [flags]
export Export the Remediate images to a tar file.

Usage:

docker-compose run remediate export [flags]
generate-docs Generates the CLI documentation.

Markdown files are created at the specified path detailing the CLI commands.

Usage:

docker-compose run remediate generate-docs [path] [flags]
help Displays the help commands.

Usage:

docker-compose run remediate help [command] [flags]
import Import the Remediate images from a tar file.

Usage:

docker-compose run remediate import [flags]

In addition to the available global flags, you can use the following flag with the import command:

  • --config string The config file (default is $HOME/.installer.yaml) (default: .installer.yml)
logs Displays the application service logs.

Usage:

docker-compose run remediate logs [flags]

In addition to the available global flags, you can use the following flags with the logs command:

  • --service string - Display logs for only this service.
  • --since string - Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) (default "4h").
    Note: By default the logs command returns logs for the last 8 hours only. Use the --since flag to return logs for a time period different from the default.
mayday Creates a mayday tarball containing debug information (including the audit log) for troubleshooting with the Puppet support team.

Usage:

docker-compose run remediate mayday [flags]

In addition to the available global flags, you can use the following flag with the mayday command:

  • --since string - Show logs since timestamp (e.g. 2013-01-02T13:23:37). You can also use an integer with m or h. For example. 42m for 42 minutes, or 1h for 1 hour. The default is "4h".
reset Deletes sources, credentials, user passwords, and resets the application to an uninstalled state.

Usage:

docker-compose run remediate reset [flags]

In addition to the available global flags, you can use the following flag with the reset command:

  • --quietly - Hides the splash screen.
restart Restarts the application.

Usage:

docker-compose run remediate restart [flags]

In addition to the available global flags, you can use the following flag with the restart command:

  • --quietly - Hides the splash screen.
refresh-internal-certs Refreshes internal docker certificates. Remediate uses a set of internal Docker certificates that are valid for one year only. On offline instances, expired certificates are not updated automatically on upgrade. Use this command refresh any expired certificates. This command does not refresh any certificates you have set using the set-frontdoor-cert or start commands.

Usage:

docker-compose run remediate refresh-internal-certs [flags]

In addition to the available global flags, you can use the following flags with the refresh-internal-certs command:

  • --quietly - Hides the splash screen.
  • -o, --offline - start without internet access
set-frontdoor-cert Restarts Remediate using the specified certificate and key.

Usage:

set-frontdoor-cert --certfile [string] --keyfile [string] [flags]

In addition to the available global flags, you can use the following flags with the set-frontdoor-cert command:

  • --cert-file - TLS certificate to be used by the front door.
  • --key-file - TLS certificate private key to be used by the front door.
    Note: The --cert-file and --key-file flags must be used together.
  • --quietly - Hides the splash screen.
  • -o, --offline - start without internet access
set-license Sets a new license.

Usage:

docker-compose run remediate set-license [license-file] [flags]

In addition to the available global flags, you can use the following flag with the set-license command:

  • --quietly - Hides the splash screen.
set-password Sets a new user administration login password that allows you to log in to the user administration UI. This operation may take several minutes.
Important: This command sets the password for the user administration UI admin user only. The main Remediate UI admin user password is set via the user administration UI. For more information on setting the Remediate UI admin user password, see Add new users.
start Initializes and starts the application.

Usage:

docker-compose run remediate start [flags]

In addition to the available global flags, you can use the following flags with the start command:

  • --cert-file - TLS certificate to be used by the Remediate UI.
  • --key-file - TLS certificate private key to be used by the Remediate UI.
    Note: The --cert-file and --key-file flags must be used together.
  • --license-file string - License file (default is $PWD/license.json)
  • --quietly - Hides the splash screen.
  • -o, --offline - start without internet access
stop Stops the application.

Usage:

docker-compose run remediate stop [flags]

In addition to the available global flags, you can use the following flag with the stop command:

  • --quietly - Hides the splash screen.
unset-frontdoor-cert Unsets any TLS certificate set by the set-frontdoor-cert or start commands and reverts to internally generated , self signed remediate certificate.

Usage

docker-compose run remediate unset-frontdoor-cert [flags]

In addition to the available global flags, you can use the following flags with the unset-frontdoor-cert command:

  • --quietly - Hides the splash screen.
  • -o, --offline - start without internet access
update Updates to the latest version.

Usage:

docker-compose run remediate update [flags]

In addition to the available global flags, you can use the following flags with the update command:

  • --quietly - Hides the splash screen.
  • --version string - Version to update to (default "latest").

The update command can also be used with the list sub-command or with its own local flags.
update list Shows a list of available versions.

Usage:

docker-compose run remediate update list [flags]
vr-cert Manage SSL certificates for VR containers:
  • add - Adds a CA certificate to VR service. The path must be relative and must be a sub-folder of the current folder.
  • list - Lists CA certificates for VR service.
  • remove - Removes a CA certificate from VR service.

Usage:

docker-compose run remediate vr-cert add <CA cert path>
docker-compose run remediate vr-cert list
docker-compose run remediate vr-cert remove <CA cert>

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]
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