Bug 1248220
| Summary: | [Docs] [Director] Issues with overcloud package update documentation | ||
|---|---|---|---|
| Product: | Red Hat OpenStack | Reporter: | Zane Bitter <zbitter> |
| Component: | documentation | Assignee: | Dan Macpherson <dmacpher> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Zane Bitter <zbitter> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | Director | CC: | adahms, yeylon |
| Target Milestone: | ga | Keywords: | Documentation |
| Target Release: | Director | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-01-11 10:09:09 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
Zane Bitter
2015-07-29 22:02:07 UTC
Assigning to Dan for review. The first two look good now, but the breakpoint part is still potentially misleading - this doesn't really describe the situation: "The breakpoint process is usually automatic. However, the -i option provides an interactive mode that requires confirmation at each breakpoint." The breakpoint process is automatic (with manual confirmations) when you specify the -i option. When you don't specify the -i option, nothing happens at all. No packages are updated. The overcloud stack moves to the UPDATE_IN_PROGRESS state and stays there for several hours (holding a lock that prevents you from making other changes to the stack), until it finally times out and moves to UPDATE_FAILED without having ever attempted to update any packages. This is because the command line client, which is responsible for clearing the breakpoints, has exited, so Heat hits the first breakpoint and stops. The user should always, always, always use -i, because that's the only way the breakpoints get cleared. If you accidentally run the command without -i (or you run it with -i but accidentally exit prematurely, e.g. with Ctrl-C), the fix is to run it again with -i - it will automatically detect the existing operation in progress and continue clearing breakpoints where it left off. No prob, I can update this. However, this also raises a question: Why have -i as an option if it's compulsory? If users should always include the -i, why not remove the -i option and make the -i happen automatically? Is there ever a situation where they wouldn't use -i? Yep, I agree it was probably a mistake to make it an option. How does this sound: Running an update on all nodes in parallel might cause problems. For example, an update of a package might involve restarting a service, which can disrupt other nodes. This is why the update process updates each node using a set of breakpoints. This means nodes are updated one by one. When one node completes the package update, the update process moves on to the next node. ## IMPORTANT ## The update process also requires the <option>-i</option> option. This puts the command an interactive mode that requires confirmation at each breakpoint. Without the <option>-i</option> option, the Overcloud nodes will not update their packages. A lot better. Consider changing the last sentence to something like: "Without the <option>-i</option> option, the update will remain paused at the first breakpoint. The update process can be resumed by running the command again with the <option>-i</option> option." so that people know how to recover when they inevitably miss the option out. Good idea. Adding that in. This is now live: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/7/html/Director_Installation_and_Usage/sect-Updating_Overcloud_Packages.html Zane, how are the changes? Anything else in that section that needs a fix? This content is live on the Customer Portal. Closing. |