chef-manage-ctl (executable)

[edit on GitHub]

_images/a2_docs_banner.svg

Warning

Chef Manage is deprecated. The Chef Enterprise Automation Stack allows you to define infrastructure, security policies, and application dependencies as code, deliver the stack via an automated pipeline to any platform, and deploy, observe, and manage the stack over its lifecycle. Chef Automate is included as part of the Chef license agreement and is available via subscription.

Danger

This documentation applies to a deprecated version of Chef Automate and will reach its End-Of-Life on December 31, 2019. See the Chef Automate site for current documentation. The new Chef Automate includes newer out-of-the-box compliance profiles, an improved compliance scanner with total cloud scanning functionality, better visualizations, role-based access control and many other features. The new Chef Automate is included as part of the Chef Automate license agreement and is available via subscription.

The Chef management console includes a command-line utility named chef-manage-ctl. This command-line tool is used to reconfigure, cleanse (reset the Chef management console to initial configuration settings), and uninstall the Chef management console.

cleanse

The cleanse subcommand is used to re-set the Chef management console to the state it was in prior to the first time the reconfigure subcommand is run. This command will destroy all data, configuration files, and logs. The software that was put on-disk by the package installation will remain; re-run chef-manage-ctl reconfigure to recreate the default data and configuration files.

This subcommand has the following syntax:

$ chef-manage-ctl cleanse

help

The help subcommand is used to print a list of all available chef-manage-ctl commands.

This subcommand has the following syntax:

$ chef-manage-ctl help

reconfigure

The reconfigure subcommand is used when changes are made to the manage.rb file to reconfigure the server. When changes are made to the manage.rb file, they will not be applied to the Chef management console configuration until after this command is run.

This subcommand has the following syntax:

$ chef-manage-ctl reconfigure

show-config

The show-config subcommand is used to view the configuration that will be generated by the reconfigure subcommand. This command is most useful in the early stages of a deployment to ensure that everything is built properly prior to installation.

This subcommand has the following syntax:

$ chef-manage-ctl show-config

uninstall

The uninstall subcommand is used to manage the hooks between runit and sysvinit or upstart. This subcommand does not uninstall the Chef management console or remove .rpm or .deb files.

This subcommand has the following syntax:

$ chef-manage-ctl uninstall