-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(PE-38815-18) Official support of Add replica plan (#484)
* PE-38815 add_replica plan updated, test matrix added (#480) * (PE-38818) Removing experimental and private from add_replica (#478) * (PE-38818) Removing experimental and private from add_replica * Updating Reference.md --------- Co-authored-by: Neil Anderson <[email protected]> * (PE-38817) Adding docs for add replica (#477) Co-authored-by: Neil Anderson <[email protected]> * chore: update test-add-replica workflow - Remove unnecessary quotes from YAML keys and values - Standardize single quotes for string values - Improve readability by removing extra blank lines * feat(workflows): add console password to test-add-replica-matrix job - Included `console_password` parameter in the test-add-replica-matrix job. - Utilizes `${{ secrets.CONSOLE_PASSWORD }}` for secure password management. * (PE-38817) Text fixes for add_replica docs (#496) * PE-39228 add_replica smoke test (#497) * PE-39228 Smoke test created and added to workflow * PE-39228 Workflow updated * PE-39228 Spec updated, smoke test added to matrix * PE-39228 Versions updated, push trigger removed from matrix * PE-39228 whitespace fixed * chore(workflow): update test-add-replica-matrix to use single version - Removed version `2021.7.9` from the matrix, leaving only `2023.8.0`. This change simplifies the testing matrix by focusing on the latest version. * chore(workflow): update test-add-replica-matrix to use single version - Changed `version` matrix to use an array with only `2023.8.0`. This change simplifies the testing matrix by focusing on the latest version. * docs: update REFERENCE.md to use asterisks for list items - Changed list item markers from hyphens to asterisks for consistency. - Ensured all list items in the document follow the same format. * add_replica docs updated --------- Co-authored-by: Neil Anderson <[email protected]> Co-authored-by: Neil Anderson <[email protected]> Co-authored-by: Aaron Shannon <[email protected]>
- Loading branch information
4 people
authored
Sep 12, 2024
1 parent
68329f0
commit 3ef10ca
Showing
9 changed files
with
307 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| name: Add replica matrix | ||
| on: | ||
| pull_request: | ||
| paths: | ||
| - .github/workflows/**/* | ||
| - spec/**/* | ||
| - lib/**/* | ||
| - tasks/**/* | ||
| - functions/**/* | ||
| - types/**/* | ||
| - plans/**/* | ||
| - hiera/**/* | ||
| - manifests/**/* | ||
| - templates/**/* | ||
| - files/**/* | ||
| - metadata.json | ||
| - Rakefile | ||
| - Gemfile | ||
| - provision.yaml | ||
| - .rspec | ||
| - .rubocop.yml | ||
| - .puppet-lint.rc | ||
| - .fixtures.yml | ||
| branches: [main] | ||
| workflow_dispatch: {} | ||
| jobs: | ||
| test-add-replica: | ||
| name: PE ${{ matrix.version }} ${{ matrix.architecture }} on ${{ matrix.image }} | ||
| runs-on: ubuntu-20.04 | ||
| env: | ||
| BOLT_GEM: true | ||
| BOLT_DISABLE_ANALYTICS: true | ||
| LANG: en_US.UTF-8 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| architecture: [standard, standard-with-dr, large, extra-large] | ||
| version: [2023.8.0] | ||
| image: [almalinux-cloud/almalinux-8] | ||
| steps: | ||
| - name: Checkout Source | ||
| uses: actions/checkout@v2 | ||
| - name: Activate Ruby 2.7 | ||
| uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: '2.7' | ||
| bundler-cache: true | ||
| - name: Print bundle environment | ||
| if: ${{ github.repository_owner == 'puppetlabs' }} | ||
| run: | | ||
| echo ::group::info:bundler | ||
| bundle env | ||
| echo ::endgroup:: | ||
| - name: Provision test cluster (specified architecture and a spare replica) | ||
| timeout-minutes: 15 | ||
| run: | | ||
| echo ::group::prepare | ||
| mkdir -p $HOME/.ssh | ||
| echo 'Host *' > $HOME/.ssh/config | ||
| echo ' ServerAliveInterval 150' >> $HOME/.ssh/config | ||
| echo ' ServerAliveCountMax 2' >> $HOME/.ssh/config | ||
| bundle exec rake spec_prep | ||
| echo ::endgroup:: | ||
| echo ::group::provision | ||
| bundle exec bolt plan run peadm_spec::provision_test_cluster \ | ||
| --modulepath spec/fixtures/modules \ | ||
| provider=provision_service \ | ||
| image=${{ matrix.image }} \ | ||
| architecture=${{ matrix.architecture }}-and-spare-replica | ||
| echo ::endgroup:: | ||
| echo ::group::info:request | ||
| cat request.json || true; echo | ||
| echo ::endgroup:: | ||
| echo ::group::info:inventory | ||
| sed -e 's/password: .*/password: "[redacted]"/' < spec/fixtures/litmus_inventory.yaml || true | ||
| echo ::endgroup:: | ||
| - name: Install PE on test cluster | ||
| timeout-minutes: 120 | ||
| run: | | ||
| bundle exec bolt plan run peadm_spec::install_test_cluster \ | ||
| --inventoryfile spec/fixtures/litmus_inventory.yaml \ | ||
| --modulepath spec/fixtures/modules \ | ||
| architecture=${{ matrix.architecture }} \ | ||
| version=${{ matrix.version }} \ | ||
| console_password=${{ secrets.CONSOLE_PASSWORD }} \ | ||
| code_manager_auto_configure=true | ||
| - name: Run add_replica plan | ||
| timeout-minutes: 60 | ||
| run: | | ||
| bundle exec bolt plan run peadm_spec::add_replica -v \ | ||
| --inventoryfile spec/fixtures/litmus_inventory.yaml \ | ||
| --modulepath spec/fixtures/modules \ | ||
| --stream | ||
| - name: Verify that replica was added | ||
| timeout-minutes: 10 | ||
| run: | | ||
| bundle exec bolt plan run peadm_spec::verify_replica -v \ | ||
| --inventoryfile spec/fixtures/litmus_inventory.yaml \ | ||
| --modulepath spec/fixtures/modules | ||
| - name: Tear down test cluster | ||
| if: ${{ always() }} | ||
| continue-on-error: true | ||
| run: |- | ||
| if [ -f spec/fixtures/litmus_inventory.yaml ]; then | ||
| echo ::group::tear_down | ||
| bundle exec rake 'litmus:tear_down' | ||
| echo ::endgroup:: | ||
| echo ::group::info:request | ||
| cat request.json || true; echo | ||
| echo ::endgroup:: | ||
| fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Add Replica | ||
|
|
||
| - [Add Replica](#Add-replica) | ||
| - [Introduction](#Introduction) | ||
| - [Adding a replica to standard and large infrastructures](#Adding-a-replica-to-standard-and-large-infrastructures) | ||
| - [Adding a Replica to extra large infrastructure](#Adding-a-Replica-to-extra-large-infrastructure) | ||
| - [Running the `add_replica` plan](#running-the-add_replica-plan) | ||
| - [Parameters](#parameters) | ||
|
|
||
| ## Introduction | ||
|
|
||
| The `peadm::add_replica` plan is designed to setup disaster recovery (DR) of a Puppet Enterprise primary server. This is achieved by adding a primary replica to your system. Although this plan doesn't change your PE architecture, adding DR depends on the structure of your current architecture. | ||
|
|
||
| In the case of standard and large installations, DR can be achieved by simply utilising this plan and adding the primary replica. In the case of an extra large infrastructure which includes an external DB, a replica DB is also required. This can be done with the `peadm::add_database` plan. For more detail see [Adding External Databases with peadm::add_database](expanding.md#adding-external-databases-with-peadmadd_database). | ||
|
|
||
| Please note, to setup a replica you must have Code Manager configured. To learn more about code manager, please see [Puppet Docs](help.puppet.com). | ||
|
|
||
| ... | ||
|
|
||
| ## Adding a replica to standard and large infrastructures | ||
| Below is an example of the required parameters to add a primary replica. These parameters can be passed in-line or as a params file. | ||
|
|
||
| ```json | ||
| { | ||
| "primary_host": "pe-core-0.lab1.puppet.vm", | ||
| "replica_host": "pe-replica-0.lab1.puppet.vm" | ||
| } | ||
| ``` | ||
|
|
||
| ## Adding a Replica to extra large infrastructure | ||
| In the below example, we already have an external DB and a replica of it. This means that we should pass in the additional parameter of the replica's hostname. | ||
|
|
||
| ```json | ||
| { | ||
| "primary_host": "pe-xl-core-0.lab1.puppet.vm", | ||
| "compiler_host": "pe-xl-replica-0.lab1.puppet.vm", | ||
| "replica_postgresql_host": "pe-xl-postgresql-replica-0.lab1.puppet.vm" | ||
| } | ||
| ``` | ||
|
|
||
| ## Running the `add_replica` plan | ||
|
|
||
| ``` | ||
| bolt plan run peadm::add_replica --params @params.json | ||
| ``` | ||
|
|
||
| The plan performs the following steps: | ||
|
|
||
| 1. Installs the Puppet agent on the new replica host. | ||
| 2. Updates classifications with new replica configuration. | ||
| 3. Provisions the infrastructure with PE. | ||
|
|
||
| ## Parameters | ||
|
|
||
| ### `primary_host` | ||
|
|
||
| - **Type:** `Peadm::SingleTargetSpec` | ||
| - **Description:** | ||
| The hostname and certname of the PE primary server. | ||
|
|
||
| ### `replica_host` | ||
|
|
||
| - **Type:** `Peadm::SingleTargetSpec` | ||
| - **Description:** | ||
| The hostname and certname of the replica VM. | ||
|
|
||
| ### `primary_postgresql_host` | ||
|
|
||
| - **Type:** `Optional[Peadm::SingleTargetSpec]` | ||
| - **Description:** | ||
| The target specification for the primary PostgreSQL host that the new replica will synchronize with. This is the database server from which the replica will replicate data. | ||
|
|
||
| ### `token_file` | ||
|
|
||
| - **Type:** `Optional[String]` | ||
| - **Description:** | ||
| The Path to token file, only required if located in a non-default location. | ||
|
|
||
|
|
||
|
|
||
| ## Replica promotion and Replica replacement | ||
|
|
||
| Please see the notes on these scenarios in [automated Recovery](automated_recovery.md#recover-from-failed-primary-puppet-server) | ||
|
|
||
| ## Known Issue on Puppet Enterprise Version 2021.x | ||
|
|
||
| When running the add_replica plan to replace an existing replica in your infrastructure, the old replica will not be removed as expected. Instead, both the old and new primary replicas will be present. | ||
|
|
||
| This is a known issue and will be fixed in a future release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.