Skip to content

Expanding.md doc refers to plans that are not available in the ADM module #309

Open
@zigsphere

Description

Describe the Change You Would Like

The commands mentioned in https://github.com/puppetlabs/puppetlabs-peadm/blob/main/documentation/expanding.md, such as bolt plan run peadm::add_replica primary_host=<primary-server-fqdn> replica_host=<new-replica-server-fqdn> replica_postgresql_host=<replica-postgres-server-fqdn> are not available in the Bolt plan.

$ bolt project init foo --modules puppetlabs-peadm                                                                                                                            
Installing project modules

  → Resolving module dependencies, this might take a moment

  → Writing Puppetfile at /Users/user/bolt/foo/Puppetfile

  → Syncing modules from /Users/user/bolt/foo/Puppetfile to
    /Users/user/bolt/foo/.modules

  → Generating type references

Successfully synced modules from /Users/user/bolt/foo/Puppetfile to /Users/user/bolt/foo/.modules
Successfully created Bolt project at /Users/user/bolt/foo
$ bolt plan show                                                                                                                                                        
Plans
  aggregate::count                    Run a task, command, or script on targets and aggregate the results...
  aggregate::targets                  Run a task, command, or script on targets and aggregate the results...
  canary                              Run a task, command or script on canary targets before running it on...
  facts                               A plan that retrieves facts and stores in the inventory for...
  facts::external                     A plan that generates external facts based on the provided modulepath...
  facts::info                         A plan that prints basic OS information for the specified targets. It...
  peadm::add_database
  peadm::convert                      Convert an existing PE cluster to a PEAdm-managed cluster
  peadm::install                      Install a new PE cluster
  peadm::modify_certificate           Modify the certificate of one or more targets
  peadm::status                       Return status information from one or more PE clusters in a table format
  peadm::upgrade                      Upgrade a PEAdm-managed cluster
  puppet_agent::run                   Starts a Puppet agent run on the specified targets.
  puppet_connect::test_input_data     Tests that the provided Puppet Connect input data is complete, meaning...
  puppetdb_fact                       Collect facts for the specified targets from PuppetDB and store...
  reboot                              Reboots targets and waits for them to be available again.
  secure_env_vars                     Run a command or script with sensitive environment variables.
  terraform::apply
  terraform::destroy

As you can see above, peadm::add_replica is not available.

Please either remove the documentation referring to the non-existing plans or explain how to add these plans as they are not available in the latest version of the module.

Thanks

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions