Bug 1329915

Summary:	Openshift doesn't accept app aliases containing an underscore
Product:	OpenShift Online	Reporter:	contact
Component:	Master	Assignee:	Vu Dinh <vdinh>
Status:	CLOSED WONTFIX	QA Contact:	weiwei jiang <wjiang>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	2.x	CC:	aos-bugs, jokerman, mmccomas, tiwillia, vdinh, wsun
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-04-27 15:37:49 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 contact 2016-04-24 21:09:10 UTC

Description of problem:
Openshift doesn't accept app aliases that contain one or more "_" (underscore).


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

How reproducible:
Always.

Steps to Reproduce:
1. attempt to add an alias with an underscore, for example "my_alias.example.com" (either through rhc commandline tool or website)

Actual results:
Throws error "The specified alias is not allowed: 'my_alias.example.com'"

Expected results:
Accept the alias. If there is an actual reason for not accepting aliases with underscores (don't see why it should be, but what do I know), throw a more specific error.

Additional info:
At least specify alias character constraints in the docs...

Comment 2 Vu Dinh 2016-04-27 15:37:49 UTC

Hi,

Unfortunately, since the underscore is not allowed proper hostname or subdomain, we can't change the code to accept underscores.

Please look at this for further details:

https://github.com/openshift/origin-server/pull/6384

Thanks,
Vu

Comment 3 contact 2016-04-27 16:21:51 UTC

(In reply to Vu Dinh from comment #2)
> Hi,
> 
> Unfortunately, since the underscore is not allowed proper hostname or
> subdomain, we can't change the code to accept underscores.
> 
> Please look at this for further details:
> 
> https://github.com/openshift/origin-server/pull/6384
> 
> Thanks,
> Vu

Well, is it possible to specify this when the alias is rejected? "The specified alias could not be set, because it contains disallowed characters: 'my_alias.example.com'" I understand that you're probably unable to specify WHICH characters caused the string to be rejected, but anything more specific than "was rejected" would help.

At the very least, can't you add a notice about this restriction to the Docs? 
* https://developers.openshift.com/managing-your-applications/domains-ssl.html
* https://access.redhat.com/documentation/en-US/OpenShift_Online/2.0/html/User_Guide/sect-Custom_Domains_and_SSL_Certificates.html

It would be ideal if it was also mentioned on the New Alias form. "An alias cannot contain the character "_" (underscore)" (and any other disallowed characters).

I understand you're not able to modify the code, but the unhelpful error message and/or missing documentation is still a bug. Should I open a new bug report, since this one is closed?

Comment 4 Vu Dinh 2016-04-27 16:37:06 UTC

Hi,

My apology for the oversight. I should have given you some info on that doc fix. You can file an issue with openshift/devcenter on github for the documentation fix. That will be great actually.

I think the section of that documents is here:

https://github.com/openshift/devcenter/blob/be2521cbccd1c15bc83149d79399c4fb511efded/source/managing-your-applications/domains-ssl.adoc

Thanks in advance,
Vu

Comment 5 contact 2016-04-27 21:19:27 UTC

(In reply to Vu Dinh from comment #4)
> Hi,
> 
> My apology for the oversight. I should have given you some info on that doc
> fix. You can file an issue with openshift/devcenter on github for the
> documentation fix. That will be great actually.
> 
> I think the section of that documents is here:
> 
> https://github.com/openshift/devcenter/blob/
> be2521cbccd1c15bc83149d79399c4fb511efded/source/managing-your-applications/
> domains-ssl.adoc
> 
> Thanks in advance,
> Vu

Thank you, will do. Can you give me more info on which characters are not allowed in domain aliases, aside from the underscore?

Comment 6 Vu Dinh 2016-04-28 13:36:52 UTC

Hi,

According to this article https://tools.ietf.org/html/rfc952 , a "name" (Net, Host, Gateway, or Domain name) is a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-), and period (.). So, any other characters are not allowed essentially.

Vu

Comment 7 contact 2016-04-28 13:45:32 UTC

(In reply to Vu Dinh from comment #6)
> Hi,
> 
> According to this article https://tools.ietf.org/html/rfc952 , a "name"
> (Net, Host, Gateway, or Domain name) is a text string up to 24 characters
> drawn from the alphabet (A-Z), digits (0-9), minus sign (-), and period (.).
> So, any other characters are not allowed essentially.
> 
> Vu

Okay, I'll pass it on. Thank you for your help.