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

Missing Parameters in Multi-Region Compiler Install Steps

    XMLWordPrintable

    Details

    • Template:
    • Story Points:
      2
    • Sprint:
      2021.07.20-08.17
    • Zendesk Ticket IDs:
      43497
    • Zendesk Ticket Count:
      1
    • QA Risk Assessment:
      Needs Assessment

      Description

      Problem:

      In our compiler installation docs, we mention multi-region/multi-data-center setups in a few subsections. If you follow these instructions to a tee, you'll end up with all your agent nodes connecting to a single compiler/load balancer (bar the install script) instead of each region's compiler/load balancer. This defeats the purpose of even setting up compilers local to each data-center.

      Suggested improvement:

      <Doc URL>
      https://puppet.com/docs/pe/2019.8/installing_compilers.html
      https://puppet.com/docs/pe/2021.0/installing_compilers.html

      Current text :

      Under "Load balancing for geodiverse locations":

      If you have load balancers in multiple data centers, set the pe_repo::compile_master_pool_address in Hiera at the point of locational demarcation. With multiple data locations, specify this value at the lowest point in your hierarchy that still accurately provides appropriate values for each location. For example[...]

      Under "Configure compilers":

      Important: If you have load balancers in multiple data centers, you must configure compile_master_pool_address using Hiera, instead of using configuration data in the console, as described in this step. Using either of these methods updates the agent install script URL displayed in the console.

      Suggested improvement:

      In the "Load balancing for geodiverse locations" section, we should include instructions on configuring the puppet_enterprise::profile::agent class's manage_puppet_conf, pcp_broker_list, master_uris, server_list parameters per-region in hieradata.

      In the first "Important" notice box under "Configure compilers", mention the above parameters in addition to compile_master_pool_address, and recommend skipping the entire "Configure compilers" section's steps.

      Summary:

      In multi-region scenarios, the steps we provide will configure agent nodes to connect to a single load balancer/compiler (bar grabbing the install script). This needs to be changed, else we're negating the purpose of multi-region compilers/load balancers.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              melissa.amos Melissa Amos
              Reporter:
              miranda.streeter Miranda Streeter
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support