Bug 1403906

Summary:	[Docs][DNSAAS] Fix tenant and region references in the DNS-as-a-Service Guide
Product:	Red Hat OpenStack	Reporter:	Rafal Szmigiel <rszmigie>
Component:	documentation	Assignee:	Lukas Ruzicka <lruzicka>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Petr Kovar <pkovar>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	9.0 (Mitaka)	CC:	lbopf, rszmigie, srevivo
Target Milestone:	async	Keywords:	Documentation
Target Release:	9.0 (Mitaka)
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2017-01-09 08:44:52 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:

Description Rafal Szmigiel 2016-12-12 15:39:29 UTC

Description of problem:

Our documentation for manual installation of DNSaaS available at https://access.redhat.com/documentation/en/red-hat-enterprise-linux-openstack-platform/7/paged/dnsaas-guide/chapter-2-manual-dnsaas-installation contains two typos.

1) Example in paragraph 3 - Create the DNSaaS service accounts and endpoint in OpenStack Identity (keystone): This example uses the DNSaaS host IP address 192.168.100.20. You will likely need to update these steps to suit your environment.

says:

# keystone user-role-add --user designate --role admin --tenant services

but there is no tenant services by default in OSP but service

furthermore

# keystone endpoint-create --service designate --publicurl "http://192.168.100.20:9001" --adminurl "http:/192.168.100.20:9001" --internalurl "http://192.168.100.20:9001" --region RegionOne

but by default RH OSP comes with regionOne instead of RegionOne.





Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:
Using the examples keystone complains about missing tenant for the first typo, for the second one endpoint is created in region "RegionOne" which doesn't exist. Especially the second typo is misleading as it doesn't cause error explicitly.

Expected results:


Additional info:

Comment 1 Rafal Szmigiel 2016-12-12 15:57:37 UTC

I provided URL to OSP 7 documentation but the same applies to OSP 9 as well: https://access.redhat.com/documentation/en/red-hat-openstack-platform/9/paged/dns-as-a-service-guide/chapter-2-manual-dnsaas-installation

Comment 2 Lucy Bopf 2016-12-22 05:08:16 UTC

Assigning to Lukas for review.

Lukas, I'm targeting this at OSP 9, but I suspect it may also need to be corrected in OSP 7, 8, and 10. Please review those versions as well as part of this bug.

Comment 4 Rafal Szmigiel 2017-01-02 09:52:48 UTC

I have confirmed that this bug is valid for DNSaaS configuration for the following RH OSP releases:

OSP7:
https://access.redhat.com/documentation/en/red-hat-enterprise-linux-openstack-platform/7/paged/dnsaas-guide/chapter-2-manual-dnsaas-installation

OSP8:
https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/paged/dns-as-a-service-guide/chapter-2-manual-dnsaas-installation

OSP9:
https://access.redhat.com/documentation/en/red-hat-openstack-platform/9/paged/dns-as-a-service-guide/chapter-2-manual-dnsaas-installation

OSP10:
https://access.redhat.com/documentation/en/red-hat-openstack-platform/10/paged/dns-as-a-service-guide/chapter-2-manual-dnsaas-installation

Best Regards,

Rafał

Comment 6 Rafal Szmigiel 2017-01-03 08:48:30 UTC

Please note that by default OSP creates regionOne which is different region than RegionOne used in DNSaaS configuration. This causes confusion because an example provided by us creates endpoint in non-existing region. While this is still correct from the syntax point of view (it just adding a new region) it will cause confusion. Therefore I'd suggest to stay with using existing "regionOne" region.

Thanks!

Rafal

Comment 7 Lukas Ruzicka 2017-01-05 08:13:03 UTC

(In reply to Rafal Szmigiel from comment #6)
> Please note that by default OSP creates regionOne which is different region
> than RegionOne used in DNSaaS configuration. This causes confusion because
> an example provided by us creates endpoint in non-existing region. While
> this is still correct from the syntax point of view (it just adding a new
> region) it will cause confusion. Therefore I'd suggest to stay with using
> existing "regionOne" region.
> 
> Thanks!
> 
> Rafal

Ok, that explained my question. The similarity of RegionOne and regionOne was confusing me, too. I am changing the given occurence only and leaving the rest untouched. 

Thanks for clarification.

Lukas

Comment 8 Lukas Ruzicka 2017-01-09 08:44:52 UTC

All changed guides were uploaded to the Customer Portal.