Bug 1194120

Summary: [doc] need additional info about the config/settings.yaml file
Product: Red Hat Satellite Reporter: Megan Lewis <melewis>
Component: Docs Provisioning GuideAssignee: Allison Heslin <aheslin>
Status: CLOSED CURRENTRELEASE QA Contact: Brandi Munilla <bmcelvee>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.0.0CC: adahms, bkearney
Target Milestone: Unspecified   
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-08-14 23:08:59 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Megan Lewis 2015-02-19 04:55:55 UTC
"After first logging in to the website you are presented with this sentences:

Before you can use Satellite 6 for the first time there are a few tasks that must be performed. You must decide how you wish to use the software, and update the primary settings file config/settings.yaml and the settings to indicate your selections.

The "config/settings.yaml" is not a link, but the word "settings" immediately following it is. Does that link take you to the "config/settings.yaml"? Because the way it's worded makes them sound like separate entities. And there isn't any information on the page nor the Provisioning Guide about where the "config/settings.yaml" is located." 

Based on this comment from the Provisioning Guide announcement. https://access.redhat.com/discussions/1294043

Comment 1 Athene Chan 2015-02-19 05:16:13 UTC
Feedback is appreciated! This will be added into the list of possible improvements set later in the year.

Comment 3 RHEL Program Management 2015-02-19 10:23:32 UTC
Since this issue was entered in Red Hat Bugzilla, the release flag has been
set to ? to ensure that it is properly evaluated for this release.

Comment 4 RHEL Program Management 2015-04-21 16:06:11 UTC
Since this issue was entered in Red Hat Bugzilla, the release flag has been
set to ? to ensure that it is properly evaluated for this release.

Comment 7 Andrew Dahms 2016-07-28 10:45:35 UTC
Assigning to Ali for review.

Ali - if memory serves, config/settings.yaml is a general configuration file that exists on your Satellite Server that allows you to set various options.

We might need to check with Adam Currier if editing this file is supported, and if so, some common options. If not, a note telling customers that they may see this screen when they first log in, but that it is just a default notice, for example.

Comment 8 Allison Heslin 2016-08-03 14:04:13 UTC
This belongs in the Host Configuration Guide now for 6.2 and is already partially described. I added a line to section 8.2 Global Parameters stating that "You should not manually change the `/etc/foreman/settings.yaml` configuration file because they are overwritten the next time you run the `satellite-installer` command."

The pop-up message referenced in the description no longer appears in 6.2.

It's also already called out in section 11.3 for remote execution.

Comment 9 Andrew Dahms 2016-08-14 23:08:59 UTC
This content is live on the Customer Portal.

Closing.