Bug 789032

Summary: DOC: ImageFactory tdl definition docs have rootpw as an optional element
Product: [Retired] CloudForms Cloud Engine Reporter: Brad P. Crochet <brad>
Component: Community WebsiteAssignee: Dan Macpherson <dmacpher>
Status: CLOSED NOTABUG QA Contact: wes hayutin <whayutin>
Severity: low Docs Contact:
Priority: unspecified    
Version: 1.0.0CC: akarol, brad, dajohnso, deltacloud-maint, dgao, dmacpher, hbrock, jclift, jrd, morazi, sloranz, ssachdev, whayutin
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-04-09 23:51:02 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Brad P. Crochet 2012-02-09 16:14:15 UTC
http://aeolusproject.github.com/imagefactory/tdl/

The rootpw element is listed as:
<rootpw>{0,1}</rootpw>
<xs:element minOccurs="0" ref="rootpw"/>

minOccurs should be 1. It's a required entry.

Comment 1 Dan Macpherson 2012-02-22 00:14:51 UTC
The TDL definition doc is generated from tdl.rng in Oz using oXygen, thanks to sloranz

If we look at the tdl.rng:
https://github.com/aeolusproject/oz/blob/master/docs/tdl.rng

Currently, <rootpw> is defined at line 39:

<optional>
  <element name='rootpw'>
    <text/>
  </element>
</optional>

But as I understand it, <rootpw> should be:

<element name='rootpw'>
  <text/>
</element>

Can I get confirmation on this?

I've CC'd sloranz so he can work his magic and regenerate the definition after I've fixed the rng file.

Comment 2 Steve Loranz 2012-02-22 15:21:10 UTC
Oz doesn't require rootpw.  We do, and we make use of a flag in Oz to enforce its existence. The tdl.rng is not wrong in that case, neither is the tdl schema doc.

Comment 3 Dan Macpherson 2012-03-26 23:34:39 UTC
Changing this to the Community Website because this is referring to the upstream documentation more so than the Enterprise docs.

Comment 4 Dan Macpherson 2012-04-09 23:51:02 UTC
As per commit 52758377ec15c39bfe184d6eaa6f508edd407b02, rootpw is now an optional element in Conductor's template-rng.xml:

https://github.com/aeolusproject/conductor/commit/52758377ec15c39bfe184d6eaa6f508edd407b02#src/app/util/template-rng.xml

And from mtaylor on aeolus-devel:
"We only clone the schema from upstream project Oz.  This rootpw is
optional upstream so we must keep in consistent.  This has already made
it in aeolus-cli.  We just needed to add it here."

https://fedorahosted.org/pipermail/aeolus-devel/2012-February/009281.html

Closing this since the schema doc is technically correct.

However, note that the following pages specify a need for the rootpw element:
* http://www.aeolusproject.org/imagefactory.html
* https://www.aeolusproject.org/redmine/projects/aeolus/wiki/Oz_template_description_language