Bolt plans for Security Compliance Management
Security Compliance Management provides convenient Bolt plans to
perform a variety of common tasks. You can use bolt module show
complyadm
in the console to see a list of available plans.
-
backup
Use this plan to back up the Security Compliance Management database and Docker volumes to a ZIP archive. When you run the plan, the location of the backup is returned. You can see of list of these backups using list_backups and restore one using restore. -
configure
Use this plan to change the configuration settings you specified during the installation of Security Compliance Management. After running this plan you are prompted for the configuration settings to change and only the affected services are restarted. -
ctl
Use this plan to runsystemctl
subcommands for the specified service. -
install
Use this plan to install Security Compliance Management. For complete instructions on how to use this plan to install Security Compliance Management, see Install Security Compliance Management. -
install::create_offline_bundle
On air-gapped environments where SSH access is not permitted to the target node, this plan can be used to create a bundle from a non air-gapped node that can be copied and extracted on the air-gapped node. This archive contains all the required modules and images required to install Security Compliance Management on a host without SSH access. -
list_backups
Use this plan to list the backups in the backup directory available for restore. You can create these backups using backup and restore them using restore. -
migrate
Use this plan to migrate data from Security Compliance Management 2.x. The plan installs a fresh instance of Security Compliance Management 3.x and allows you to migrate any 2.x data to the new install. For complete instructions on how to use this plan to migrate from 2.x to 3.x, see Migrate from Security Compliance Management 2.x to 3.x. -
restore
Use this plan to restore Security Compliance Management from a backup you created with backup. To use this plan you need to install a fresh Security Compliance Management installation that matches the version of the backup. The database and docker volumes are restored from your backup ZIP archive to the fresh installation. You can see a list of the Security Compliance Management backups using list_backups. -
support_bundle
Use this plan to gather information detailing the state of an existing Security Compliance Management installation and save it to the support bundle directory. When you run the plan, the location of the support bundle is returned. You can send this bundle to Puppet support to help them diagnose an issue. -
uninstall
Use this plan to uninstall the Security Compliance Management application and all associated data. This removes Security Compliance Management from the hosts specified in the Hiera configuration file. The configured runtime must be functional, as it is used to remove the containers, volumes, and network associated with Security Compliance Management. The runtime itself is not removed, unless you explicitly choose to do so. For complete instructions on how to use this plan to uninstall Security Compliance Management, see Uninstall Security Compliance Management. -
upgrade
Use this plan to upgrade an existing installation of Security Compliance Management. For complete instructions on how to use this plan to upgrade Security Compliance Management, see Upgrade Security Compliance Management.