Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1515011

Summary: [RFE] Review the structure of the chapter on upgrading Satellite Server and Capsule Server
Product: Red Hat Satellite Reporter: Andrew Dahms <adahms>
Component: Docs Upgrading and Updating Red Hat SatelliteAssignee: Stephen Wadeley <swadeley>
Status: CLOSED NEXTRELEASE QA Contact: Russell Dickenson <rdickens>
Severity: high Docs Contact:
Priority: high    
Version: 6.3.0CC: adahms
Target Milestone: UnspecifiedKeywords: FutureFeature
Target Release: Unused   
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-11-30 09:09:16 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:
Bug Depends On: 1451566    
Bug Blocks: 1454572    

Description Andrew Dahms 2017-11-20 00:22:17 UTC
The chapter 'Upgrading Satellite Server and Capsule Server' must be restructured to follow the following general table of contents - 

2. Upgrading Red Hat Satellite
2.1 Migrating from RHEL 6 to RHEL 7
2.2 Upgrading Satellite Server
2.2.1 Upgrading a Connected Satellite Server
2.2.2 Upgrading a Disconnected Satellite Server
2.2.3 Upgrading a Self-Registered Satellite Server
2.3 Upgrading Capsule Server
2.4 Post-Upgrade Tasks
2.4.1 Upgrading Discovery
2.4.1.1 Upgrading Discovery on Satellite Server
2.4.1.2 Upgrading Discovery on Capsule Server
2.4.2 Upgrading Satellite Clients
2.4.3 Removing the Previous Version of the Satellite Tools Repository

In particular, the following changes should be made -

* A basic, one or two line introduction should be added to each section where
  not already present. For example, the 'Upgrading Satellite Server' section.
  For this one, the 'Important' box in the current 'Upgrading to Satellite 
  Server 6.3' section should be added in the same new section rather than
  being left on its own.

* The steps to upgrade discovery must be removed from the main upgrade tasks
  and made into their own standalone sections with a very quick introduction.

* All sections directly under 'Post-Upgrade Tasks' must note whether they are
  mandatory or optional.

Comment 1 Andrew Dahms 2017-11-20 00:26:28 UTC
Assigning to Stephen for review.

Comment 2 Stephen Wadeley 2017-11-20 13:20:00 UTC
Hello

What about Puppet?

Comment 3 Stephen Wadeley 2017-11-20 21:22:37 UTC
(In reply to Stephen Wadeley from comment #2)
> Hello
> 
> What about Puppet?

Ignore that, Puppet is in it's own chapter

Comment 4 Andrew Dahms 2017-11-20 23:30:05 UTC
Roger that, Stephen!

I checked my needinfo list this morning to find this one had disappeared, and I now see why.

Let me know if there's anything we can discuss as you go along.

Comment 5 Stephen Wadeley 2017-11-22 12:33:19 UTC
Hello Andrew

Where will the material for "Migrating from RHEL 6 to RHEL 7" come from?

From here I suppose:
Bug 1451566 - [RFE] [6.3] Describe how to clone a Satellite installation from one machine to another


In that case, setting "Depends on"

Comment 6 Stephen Wadeley 2017-11-22 14:45:27 UTC
Hello Andrew

Re "Upgrading Discovery on Satellite Server"

We do not have such a section. I suppose I should make one.

In the three Satellite upgrade sections "Upgrading a Connected Satellite Server", "Upgrading a Disconnected Satellite Server", and "Upgrading a Self-Registered Satellite Server"

I see two steps related to Discovery:

Update the Discovery template in the Satellite web UI: {has some substeps}

and then later "In the Satellite web UI, go to Configure > Discovery Rules and associate selected organizations and locations with discovery rules. "

I could remove those two steps from both procedures and make one new section.

Thank you

Comment 7 Stephen Wadeley 2017-11-23 16:18:42 UTC
(In reply to Andrew Dahms from comment #0)
<snip>
> 
> In particular, the following changes should be made -
> 
> * A basic, one or two line introduction should be added to each section where
>   not already present. For example, the 'Upgrading Satellite Server' section.
>   For this one, the 'Important' box in the current 'Upgrading to Satellite 
>   Server 6.3' section should be added in the same new section rather than
>   being left on its own.
There is no Important admonition as far as I can see. I see a Warning admonition starting "If you implemented custom certificates"

Is that what I should move to the new intro section? 
Should I leave all the prerequisite where they are?

Comment 9 Andrew Dahms 2017-11-24 01:41:16 UTC
Hi Stephen,

Thank you for the needinfo request!

It looks like the structure of that particular section changed between the time when I initially raised the bug and now, mostly due to what appears to have been a failure of the build on Pantheon to rebuild after the change was made.

My apologies for the confusion.

You make a good point about prerequisites - if the content is the same for each of the major procedures, perhaps it would be better to make it a standalone topic at the start of the chapter.

In terms of the introductory text, given that there is no 'Important' box now, just a quick line such as 'This chapter outlines how to XYZ...' feels like it would do the trick, along with something similar for each of the major procedures.

Kind regards,

Andrew