search

chef / automate

Chef Automate provides a full suite of enterprise capabilities for maintaining continuous visibility into application, infrastructure, and security automation.
https://automate.chef.io/
Apache License 2.0
226 stars 113 forks source link

Update https://docs.chef.io/automate/on_prem_builder/ to cover stand alone builder install #4281

Open devopsdina opened 4 years ago

devopsdina commented 4 years ago

The docs should give an example config.toml file for configuring builder only.

The docs should clearly state if the customer should still use sudo ./chef-automate init-config to generate the config.toml and what fields are required for only builder. For example, is the FQDN required?

This should be on the page for https://docs.chef.io/automate/on_prem_builder/

internal context thread

susanev commented 4 years ago

@devopsdina i believe that is this section, https://docs.chef.io/automate/on_prem_builder/#deploy-chef-habitat-builder-with-chef-automate-auth

which describes only the required auth bits and not the rest of automate.

is there something missing or wrong from that section?

susanev commented 4 years ago

@chef/docs-team there is def something up with that section though cause it starts off saying builder and automate auth only

but then the command and output is deploying all of automate https://docs.chef.io/automate/on_prem_builder/#deploy-chef-habitat-builder-with-chef-automate-auth

i think there is missing section header or something

devopsdina commented 4 years ago

When reading https://docs.chef.io/automate/on_prem_builder/ or https://docs.chef.io/automate/on_prem_builder/#deploy-chef-habitat-builder-with-chef-automate-auth it should have all requirements on the page. For example, the requirement for an FQDN should be listed on this page, a customer shouldn't have to go to another page or jump around in the docs to understand what is required.