Bug 1392355 - dns_provider option "nsupdate" was renamed "dns_nsupdate"
Summary: dns_provider option "nsupdate" was renamed "dns_nsupdate"
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Install Guide
Version: Unspecified
Hardware: Unspecified
OS: Unspecified
medium
medium vote
Target Milestone: Unspecified
Assignee: Charles Wood
QA Contact: Stephen Wadeley
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-11-07 10:01 UTC by Stephen Wadeley
Modified: 2019-06-13 21:25 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-02-02 09:26:03 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Stephen Wadeley 2016-11-07 10:01:45 UTC
Document URL: 

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/installation-guide/chapter-5-configuring-external-services#configuring_capsule_external_dns

Section Number and Name: 

Configuring Capsule Server with External DNS

Step 5 " Edit the /etc/foreman-proxy/settings.d/dns.yml file. "

Describe the issue: 

dns_provider option "nsupdate" was renamed "dns_nsupdate"

Suggestions for improvement: 

In the code block for the example "/etc/foreman-proxy/settings.d/dns.yml file. "

change "nsupdate" to "dns_nsupdate"

For other occurrences of nsupdate on that page we should ask for SME review.

Additional information: 

https://gitlab.sat.lab.tlv.redhat.com/satellite6/smart-proxy/commit/d905c67c1067696000b0ff4fefde711c99f9e731

Comment 1 Stephen Wadeley 2016-11-07 10:05:33 UTC
Hello Dominic


Can you search the page at the link in comment 0 and confirm if any other occurrences of the word "nsupdate" on that page should be changed in addition to the option in the  "/etc/foreman-proxy/settings.d/dns.yml" file example that comment 0 asks to be changed.

Thank you

Comment 2 Andrew Dahms 2016-11-23 00:52:41 UTC
Assigning to Charles for review.

Comment 3 Lukas Zapletal 2017-02-01 15:58:18 UTC
Here is a snippet from my freshly installed Satellite 6.2. Does it help you to identify what the change was?

[root@amd-ma78gm-01 ~]# find /etc/foreman-proxy/settings.d
/etc/foreman-proxy/settings.d
/etc/foreman-proxy/settings.d/bmc.yml
/etc/foreman-proxy/settings.d/dhcp.yml
/etc/foreman-proxy/settings.d/dhcp_isc.yml
/etc/foreman-proxy/settings.d/dhcp_ms_native.yml
/etc/foreman-proxy/settings.d/dhcp_virsh.yml
/etc/foreman-proxy/settings.d/dns.yml
/etc/foreman-proxy/settings.d/dns_dnscmd.yml
/etc/foreman-proxy/settings.d/dns_nsupdate.yml
/etc/foreman-proxy/settings.d/dns_nsupdate_gss.yml
/etc/foreman-proxy/settings.d/dns_virsh.yml
/etc/foreman-proxy/settings.d/facts.yml
/etc/foreman-proxy/settings.d/logs.yml
/etc/foreman-proxy/settings.d/puppet.yml
/etc/foreman-proxy/settings.d/puppetca.yml
/etc/foreman-proxy/settings.d/realm.yml
/etc/foreman-proxy/settings.d/templates.yml
/etc/foreman-proxy/settings.d/tftp.yml
/etc/foreman-proxy/settings.d/openscap.yml
/etc/foreman-proxy/settings.d/discovery.yml
/etc/foreman-proxy/settings.d/pulp.yml
/etc/foreman-proxy/settings.d/pulpnode.yml
/etc/foreman-proxy/settings.d/dynflow.yml
/etc/foreman-proxy/settings.d/remote_execution_ssh.yml
[root@amd-ma78gm-01 ~]# cat /etc/foreman-proxy/settings.d/dns.yml
---
# DNS management
:enabled: https
# valid providers:
#   dns_dnscmd (Microsoft Windows native implementation)
#   dns_nsupdate
#   dns_nsupdate_gss (for GSS-TSIG support)
#   dns_virsh (simple implementation for libvirt)
:use_provider: dns_nsupdate
# use this setting if you want to override default TTL setting (86400)
:dns_ttl: 86400

Comment 4 Stephen Wadeley 2017-02-01 16:44:37 UTC
Hello Charles

The way I see it, `nsupdate` is still the correct name for the utility supplied by bind-utils.

So all example *commands* sre still correct.

The only question is then the from step 5.

Run the satellite-installer script to make the following persistent changes to the /etc/foreman-proxy/settings.d/dns.yml file. 

--foreman-proxy-dns-provider=nsupdate

Comment 5 Stephen Wadeley 2017-02-01 16:51:36 UTC
Re comment 4

If you look in /etc/foreman-proxy/settings.d/dns_nsupdate.yml you will see:

---
#
# Configuration file for 'nsupdate' dns provider
#

:dns_key: /etc/rndc.key
# use this setting if you are managing a dns server which is not localhost though this proxy
:dns_server: 10.xx.xx.xxx


So that seems to suggest the option "--foreman-proxy-dns-provider=nsupdate" should be changed to "--foreman-proxy-dns-provider=dns_nsupdate" 

Would be nice to get confirmation.

Comment 6 Kenny Tordeurs 2017-02-02 09:14:47 UTC
Hi Stephen,

I think it can still be nsupdate, according to the output of # satellite-installer --help:

On Capsule 6.2.7:
# satellite-installer --help | grep dns
~~~
--dns-provider                DNS provider (default: "nsupdate")
~~~

On Satellite 6.2.7:
# satellite-installer --help | grep dns
~~~
--foreman-proxy-dns-provider  DNS provider (default: "nsupdate")
~~~

Comment 7 Stephen Wadeley 2017-02-02 09:26:03 UTC
OK, thanks Kenny

Lets close this as NOTABUG, anyone can reopen it if they have a reason why we need to mention this low level change (as shown in comment 3, :use_provider: dns_nsupdate).


Thank you

Comment 8 Stephen Wadeley 2017-04-11 14:51:55 UTC
Seems you cannot rely on installer script's "--help" usage statement because  it seems the installer script accepts any value and then tells you that is the default:

~]# satellite-installer --help | grep dns
--foreman-proxy-dns-provider  DNS provider (default: "Fort_Knox") 

I will raise a bug.

Comment 9 Stephen Wadeley 2017-04-11 15:04:09 UTC
Re comment 8

Bug 1441285 - Installer script's "--help" output use of "default" is misleading

Comment 10 Andrew Dahms 2017-05-11 12:11:39 UTC
Clearing old needinfo request.


Note You need to log in before you can comment on or make changes to this bug.