Bug 1455324

Summary: [docs][director] Need "Configuration agent" section added to 8->9 upgrade guide
Product: Red Hat OpenStack Reporter: James Slagle <jslagle>
Component: documentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED CURRENTRELEASE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 8.0 (Liberty)CC: dmacpher, jslagle, mburns, sathlang, srevivo
Target Milestone: ---Keywords: Triaged
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-06-13 04:00:30 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:

Comment 1 Dan Macpherson 2017-05-29 03:19:16 UTC
Hi James,

Do you know which package is the affected (rhosp-director-images or openstack-tripleo-heat-templates) and the NVR people should check? I want to try and get something for customers to identify so they know they need to update the config agent.

Comment 2 Dan Macpherson 2017-05-30 17:10:47 UTC
*** Bug 1456928 has been marked as a duplicate of this bug. ***

Comment 3 Dan Macpherson 2017-05-30 17:12:12 UTC
Sofer, any chance you can answer the question in comment #1?

Comment 4 James Slagle 2017-05-30 21:36:47 UTC
(In reply to Dan Macpherson from comment #1)
> Hi James,
> 
> Do you know which package is the affected (rhosp-director-images or
> openstack-tripleo-heat-templates) and the NVR people should check? I want to
> try and get something for customers to identify so they know they need to
> update the config agent.

The new version will be:
openstack-heat-templates-0-0.2.20170112.el7ost

Any version from OSP 8 prior to that will not have the fix. Since these files were not packaged on the overcloud nodes. I'm not sure there is an easy way to tell if the fix is present or not, unless we document manually opening the files and looking at their code to see if the fix is there or not.

Or possibly we could tell people to check md5sums? That seems a bit troublesome though as we'd have to remember to update the docs if we need to patch these files again. Let me know what you think.

Also wanted to mention that the package is not yet shipped live, but that is supposed to happen this week at some point. The errata is here:
https://errata.devel.redhat.com/advisory/26134

Comment 5 James Slagle 2017-05-30 21:43:44 UTC
On further thought, this is going to affect everyone who deployed with 8 since we aren't respinning new images with this fix.

The only customers on 8 who would already have the fix is if they followed the steps from 7->8 upgrade guide already. That may be enough to mention.

Comment 6 Dan Macpherson 2017-05-31 14:35:39 UTC
Hi James,

I think I've got this sorted. Here's a draft of the content adapted for OSP8:

http://file.bne.redhat.com/~dmacpher/OpenStack/10.0/osp8-configagent/doc-Upgrade_Openstack_Guide/#sect-Updating_the_Configuration_Agent

I've rewritten the note at the beginning. Please let me know if it captures what we've discussed in this BZ.

I can push out this content when the errata gets pushed.

Comment 7 James Slagle 2017-06-02 16:51:37 UTC
(In reply to Dan Macpherson from comment #6)
> Hi James,
> 
> I think I've got this sorted. Here's a draft of the content adapted for OSP8:
> 
> http://file.bne.redhat.com/~dmacpher/OpenStack/10.0/osp8-configagent/doc-
> Upgrade_Openstack_Guide/#sect-Updating_the_Configuration_Agent
> 
> I've rewritten the note at the beginning. Please let me know if it captures
> what we've discussed in this BZ.
> 
> I can push out this content when the errata gets pushed.

The content lgtm. I see you added it to the 8 guide itself and not the 8->9 upgrade guide. However, I think what you did is actually correct, because we want people to apply this fix while doing the latest minor update for 8 and before starting on the 8-9 upgrade.

Comment 8 Dan Macpherson 2017-06-02 17:24:30 UTC
Exactly. The start of the OSP9 upgrade guide has a warning message to update to the latest version of OSP8 and links to the OSP8 update guide documentation. This was something Sofer identified:

https://bugzilla.redhat.com/show_bug.cgi?id=1454421

Also, when is the best time to push out this additional documentation?

Comment 9 James Slagle 2017-06-07 20:16:58 UTC
(In reply to Dan Macpherson from comment #8)
> Exactly. The start of the OSP9 upgrade guide has a warning message to update
> to the latest version of OSP8 and links to the OSP8 update guide
> documentation. This was something Sofer identified:
> 
> https://bugzilla.redhat.com/show_bug.cgi?id=1454421
> 
> Also, when is the best time to push out this additional documentation?

The errata is shipped live, so you can go ahead and push the docs update live.

Comment 10 Dan Macpherson 2017-06-13 04:00:30 UTC
Thanks, James! This should now be live:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/8/html-single/upgrading_red_hat_openstack_platform/#sect-Updating_the_Configuration_Agent

Closing BZ, but feel free to reopen if further changes are required.