Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCUMENT-1162

Improve PE upgrade documentation for retired master platforms

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Incomplete
    • Component/s: PE
    • Labels:
    • Template:
      Docs change request
    • CS Priority:
      Major
    • CS Severity:
      4 - Major
    • CS Affected Frequency:
      1 - Monthly or less
    • QA Risk Assessment:
      Needs Assessment

      Description

      Problem: There are several inconsistencies in our current upgrade documentation and the approach suggested to upgrade PE.

      CS team engaged  upgrading PE and the upgrade did not go very smoothly. This ticket is was created out of a retrospective we did as a CS team.

      Here is a list of issues identified with our Public upgrade docs

      1. The doc itself ** is not presented in a very consumable fashion and we need to revisit how the information is laid out. My suggestion would be to split out the upgrade paths. There are 2 potential upgrade paths for Puppet. We need break out the single document into two documents.
        1. An upgrade -> when going from version x to version y
        2. A migration -> where the underlying O/S and infrastructure needs to be recreated and a new Puppet deployment has to be done
      2. Additionally, the upgrade cautions are contextual - they don't apply to all the versions of Puppet. We should re-structure it so that customers can clearly identify if the caution is applicable for their Puppet version
      3. The documented upgrade process itself needs to be revisited as we found a few discrepancies: 
        1. Under the steps for retired platform we ask customers to Install your current PE version on the new node but this step is actually not required. In a large environment, doing prep for this step actually takes 1-2 day
        2. Running the backup/restore as documented is not feasible in very large Puppet deployments - support asked us to use their KB and do dump/restore of selective tables instead
        3. We need more detailed steps when doing a migration

      Suggested improvement:

      https://puppet.com/docs/pe/2019.8/upgrading_pe.html

       

        Attachments

          Activity

            People

            Assignee:
            ajay.sridhar Ajay Sridhar
            Reporter:
            ajay.sridhar Ajay Sridhar
            Votes:
            1 Vote for this issue
            Watchers:
            6 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support