Bug 1433421

Summary:	Overcloud Registration examples don't work
Product:	Red Hat OpenStack	Reporter:	Vagner Farias <vfarias>
Component:	documentation	Assignee:	Dan Macpherson <dmacpher>
Status:	CLOSED CURRENTRELEASE	QA Contact:	RHOS Documentation Team <rhos-docs>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	10.0 (Newton)	CC:	dmacpher, mburns, srevivo, vfarias
Target Milestone:	---
Target Release:	---
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-03-22 03:55:24 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:

Description Vagner Farias 2017-03-17 15:46:34 UTC

Description of problem:
Overcloud Registration examples in [1] are incomplete and don't work. The examples in this document imply that setting only the parameters presented in each section (customer portal, Satellite 6, Satellite 5) would be allowed, but that's not how it works. All other parameters should be provided, with empty strings.

Example used in the document to register to Satellite 6:

parameter_defaults:
  rhel_reg_activation_key: "my-openstack"
  rhel_reg_org: "1"
  rhel_reg_pool_id: "1a85f9223e3d5e43013e3d6e8ff506fd"
  rhel_reg_method: "satellite"
  rhel_reg_sat_url: "http://sat6.example.com"
  rhel_reg_sat_repo: "rhel-7-server-satellite-tools-6.2-rpms"

However, this won't work, cause it's missing several other parameters. An example that works:

parameter_defaults:
  rhel_reg_activation_key: "osp10"
  rhel_reg_auto_attach: ""
  rhel_reg_base_url: ""
  rhel_reg_environment: ""
  rhel_reg_force: ""
  rhel_reg_machine_name: ""
  rhel_reg_org: "Default_Organization"
  rhel_reg_password: ""
  rhel_reg_pool_id: "2c9ca9c359abcde10159b69d32e30250"
  rhel_reg_release: ""
  rhel_reg_repos: "rhel-7-server-rpms,rhel-7-server-extras-rpms,rhel-7-server-rh-common-rpms,rhel-ha-for-rhel-7-server-rpms,rhel-7-server-openstack-10-rpms,rhel-7-server-rhceph-2-osd-rpms,rhel-7-server-rhceph-2-mon-rpms"
  rhel_reg_sat_url: "http://sat6.example.com"
  rhel_reg_server_url: ""
  rhel_reg_service_level: ""
  rhel_reg_user: ""
  rhel_reg_type: ""
  rhel_reg_method: "satellite"
  rhel_reg_sat_repo: "rhel-7-server-satellite-tools-6.2-rpms"

Note that the not required parameters should be set to empty strings.


1: https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html/advanced_overcloud_customization/sect-registering_the_overcloud

Version-Release number of selected component (if applicable):
openstack-tripleo-heat-templates-5.1.0-7.el7ost.noarch (in case this is different in some other THT version)

How reproducible:
Always

Steps to Reproduce:
1. Configure overcloud registration following documentation example

Actual results:
Overcloud create/update fails because of missing parameters.

Expected results:
Overcloud create/update should complete successfully and nodes should be registered to Satellite.

Additional info:
This was tested only with Satellite 6, but looking at the code, I guess the same failure would happen with Customer Portal and Satellite 5 as well.

Comment 2 Dan Macpherson 2017-03-21 06:44:17 UTC

Hi Vagner,

I've updated the examples to include the missing params:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html/advanced_overcloud_customization/sect-registering_the_overcloud

(FYI, for anyone reading this BZ, all params are necessary because the rhel-registration template doesn't set any defaults.)

Vagner, was there anything further required for this BZ?

Comment 3 Vagner Farias 2017-03-21 13:38:16 UTC

Hi Dan,

Although I tested only Satellite 6, I believe Customer Portal is correct as well. However, it seems that Satellite 5 would require different repository names.

To be honest, providing rhel_reg_repos in any option is optional, depending on which ones are automatically enabled for the activation key in use. I did a quick search but couldn't find the correct repository names for Satellite 5, though.

Comment 4 Dan Macpherson 2017-03-21 16:03:21 UTC

(In reply to Vagner Farias from comment #3)
> To be honest, providing rhel_reg_repos in any option is optional, depending
> on which ones are automatically enabled for the activation key in use. I did
> a quick search but couldn't find the correct repository names for Satellite
> 5, though.

Ah that's true. The repositories wouldn't be required if using an activation key. In that case, I'll remove the repositories for all.

Comment 5 Dan Macpherson 2017-03-22 02:19:12 UTC

Hi Vagner,

I've taken the repo listing out for the Satellite 5 and 6 examples, but left them for the Customer Portal registration. It seems that you do need to specify the repo list for the Customer Portal registration as the activation key from the portal only adds the subscription pool.

I've also included a note for both Satellite examples that the repositories are linked to the activation key.

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html/advanced_overcloud_customization/sect-registering_the_overcloud

Have a look and let me know what you think.

Comment 6 Vagner Farias 2017-03-22 02:22:36 UTC

Hi Dan. Looks good to me (with the remark that I only tested on Sat6).

Comment 7 Dan Macpherson 2017-03-22 03:55:24 UTC

No problem. Based on what I know of Customer Portal and Sat5 registration, the others should work. You were right about needing all params, not just the relevant ones, due to the lack of defaults in the registration Heat templates, so at least that is rectified.