Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 912439

Summary: Cloud Engine - Procedure 7.4, step 1 provides invalid XML in example
Product: [Retired] CloudForms Common Reporter: Gabriel Szasz <gszasz>
Component: DocumentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED WONTFIX QA Contact: Dan Macpherson <dmacpher>
Severity: low Docs Contact:
Priority: low    
Version: 1.1.0   
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: 2014-08-26 04:28:44 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:
Attachments:
Description Flags
https://[CONFIGSERVER]/examples/katello-register.xml none

Description Gabriel Szasz 2013-02-18 16:44:25 UTC 
Description of problem:
Procedure 7.4 of the Cloud Engine User Guide is invalid. Both, application blueprint XML example and reference to the current examples/katello-register.xml are incorrect and lead to warnings and error in conductors UI. This might prevent customer to properly register his/her instance back to Katello.


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


How reproducible:
100%


Steps to Reproduce:
1. Setup and run katello server.
2. Setup and run conductor server.
3. Setup and run aeolus configserver.
4. Configure conductor for a provider account with properly added configserver.
5. Select katello content and export system template.
6. Use exported system template for building an image.
7. Push built image.
8. Click on "New application blueprint from image"
9. Select catalog.
10. Click on "Save"
11. Click on Edit XML
12. Copy-paste XML from the example at procedure 7.4 (step 1) into conductor UI and replace corresponding values as described in documentation. Click on Save.

or

12. Follow the note in the procedure 7.4 (step 1, below example) and download file https://[CONFIGSERVER]/examples/katello-register.xml (where [CONFIGSERVER] is FQDN or an IP address of the aeolus configserver).
13. Follow instructions written at the beginning of katello-register.xml and replace "FIXME" with image ID.
14. Copy-paste resulting XML into conductor UI and click on Save

  
Actual results:
Conductor produces following set of warnings and errors (by following the second branch of the steps to reproduce - steps 1-14):

    Deprecation Warning: Parameter 'IMPORT_BETA_KEY' in service 'GPG_KEY_IMPORT' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'KATELLO_HOST' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'KATELLO_PORT' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'KATELLO_ORG' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'KATELLO_ENV' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'KATELLO_USER' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'KATELLO_PASS' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'RELEASEVER' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'AUTO_SUBSCRIBE' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.
    Deprecation Warning: Parameter 'ACTIVATION_KEY' in service 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move it to a child value tag.

Errors

    client: Cloud Resource Profile hwp1, which is specified in XML, does not exist.


Expected results:
The blueprint should successfully pass validation and no warnings and errors should be shown by conductor.


Additional info:
This bug is closely related to bug#912429.
Comment 2 Dan Macpherson 2013-02-19 05:16:33 UTC 
(In reply to comment #0)
>     Deprecation Warning: Parameter 'IMPORT_BETA_KEY' in service
> 'GPG_KEY_IMPORT' has a type attribute. Remove the type attribute or move it
> to a child value tag.
>     Deprecation Warning: Parameter 'KATELLO_HOST' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'KATELLO_PORT' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'KATELLO_ORG' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'KATELLO_ENV' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'KATELLO_USER' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'KATELLO_PASS' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'RELEASEVER' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'AUTO_SUBSCRIBE' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.
>     Deprecation Warning: Parameter 'ACTIVATION_KEY' in service
> 'KATELLO_REGISTER' has a type attribute. Remove the type attribute or move
> it to a child value tag.

The type attributes have moved to the value tag. As the warnings implicate, including the type as part of the parameter is depreciated. Having said that, the app blueprint should still work in the current version of CloudForms Cloud Engine.

Targeting for 1.1.2
 
> Errors
> 
>     client: Cloud Resource Profile hwp1, which is specified in XML, does not
> exist.
> 

The example in the documentation does not specify "hwp1". Instead, it contains the replacement elements:

    <assembly name="[NAME]" hwp="[PROFILE]">

Indicating you need to replace [PROFILE] with a Cloud Resource Profile you've created.
Comment 3 Gabriel Szasz 2013-02-19 09:45:41 UTC 
Created attachment 699388 [details]
https://[CONFIGSERVER]/examples/katello-register.xml

Contents of https://[CONFIGSERVER]/examples/katello-register.xml - the only file currently contained in aeolus-configserver's "examples" directory.
Comment 4 Gabriel Szasz 2013-02-19 10:04:11 UTC 
> The type attributes have moved to the value tag. As the warnings implicate,
> including the type as part of the parameter is depreciated. Having said that,
> the app blueprint should still work in the current version of CloudForms
> Cloud Engine.

An example in documentation should not produce any warnings and it has to comply current XML schema.


> The example in the documentation does not specify "hwp1". Instead, it
> contains the replacement elements:
>
>     <assembly name="[NAME]" hwp="[PROFILE]">
>
> Indicating you need to replace [PROFILE] with a Cloud Resource Profile you've 
> created.

The error is related to the second branch of the steps to reproduce. Considering the use case when customer is ignoring actual example XML in documentation and instead, he/she will follow the reference to https://[CONFIGSERVER]/examples and he/she will use one (and only) example that is located there.

Cloud Engine User Guide, Procedure 7.4, Step 1, Note:
...
This example application blueprint is also available on your Audrey Configuration Server at:

https://[CONFIGSERVER]/examples
...

The https://[CONFIGSERVER]/examples contains only one file - "katello-register.xml" (see bug attachment). This file does contain profile "hwp1" without any explicit instruction that this string has to be replaced.
Comment 5 Gabriel Szasz 2013-02-19 10:44:13 UTC 
The placeholder inconsistency between Procedure 7.4, Step 1 and  "katello-register.xml" was already filed as bug#912658
Comment 7 Dan Macpherson 2014-08-26 04:28:44 UTC 
Closing this bug as CloudForms 1.x is now a retired product.