update basic setup documentation

README.md

@@ -3,6 +3,9 @@ pgBackRest Ansible Role [![Build Status](https://github.com/onaio/ansible-role/w
 
 Ansible role that installs and configures [pgbackrest](https://pgbackrest.org/).
 
+1. **Apart from starting pgbackrest server for tls setups, no other pgbackrest commands are executed by this role.**
+2. **Postgresql service is not affected by this role.**
+
 Requirements
 ------------
 
@@ -20,86 +23,25 @@ Role Variables
 
 Check the [defaults/main.yml](./defaults/main.yml) file for the full list of default variables.
 > Ensure pgbackrest_is_pg_host and pgbackrest_is_repository_host are defined accordingly. 
-> They are both true by default, this supports the most basic set up i.e. one host for pg-host and repo-host. If more than one host is involved update the respective boolean configs.
+> They are both true by default, this supports the most basic set up i.e. same host for pg-host and repo-host. If more than one host is involved update the respective boolean configs.
 ````yaml
 ---
-pgbackrest_working_directory: /tmp/build
+pgbackrest_is_pg_host: true
+pgbackrest_is_repository_host: true
+
 pgbackrest_version: 2.53
 
-pgbackrest_git_repo_release_artifact_url: "https://github.com/pgbackrest/pgbackrest/archive/release/{{ pgbackrest_version }}.tar.gz"
-
-pgbackrest_conf_template: "etc/pgbackrest/pgbackrest.conf.j2"
-pgbackrest_config_path: "{{ pgbackrest_config_dir }}/pgbackrest.conf"
-pgbackrest_config_dir: "/etc/pgbackrest"
-pgbackrest_cert_directory: "{{ pgbackrest_config_dir }}/cert"
-
-pgbackrest_service_template: "etc/systemd/system/pgbackrest.service.j2"
-pgbackrest_service_path: "/etc/systemd/system/pgbackrest.service"
-
-pgbackrest_setup_certificate: false
-pgbackrest_certificate_ca:
-pgbackrest_certificate_files:
-
-pgbackrest_pre_install_packages:
-  - wget
-  - tar
-
-pgbackrest_install_packages:
-  - python3-distutils
-  - meson
-  - gcc
-  - libpq-dev
-  - libssl-dev
-  - libxml2-dev
-  - pkg-config
-  - liblz4-dev
-  - libzstd-dev
-  - libbz2-dev
-  - libz-dev
-  - libyaml-dev
-  - libssh2-1-dev
-
-pgbackrest_cleanup_packages:
-  - python3-distutils
-  - meson
-  - gcc
-  - libpq-dev
-  - libssl-dev
-  - libxml2-dev
-  - pkg-config
-  - liblz4-dev
-  - libzstd-dev
-  - libbz2-dev
-  - libz-dev
-  - libyaml-dev
-  - libssh2-1-dev
-
-pgbackrest_binary_dir: /usr/bin
-pgbackrest_log_directory: /var/log/pgbackrest
-
-pgbackrest_create_user: true
+# user not created on pg-host, re-using postgres user created when setting up postgresql service
+pgbackrest_create_user: false
 pgbackrest_user: postgres
 pgbackrest_user_group: postgres
-pgbackrest_user_password: 
 pgbackrest_user_home: "/var/lib/postgresql"
 
-pgbackrest_is_pg_host: true
-
-pgbackrest_cleanup_after_setup: false
-
-pgbackrest_is_repository_host: true
+pgbackrest_cleanup_after_setup: true
 
 pgbackrest_repo_directories:
   - /var/lib/pgbackrest
 
-pgbackrest_temp_ssh_pub_key_export_directory: "/tmp/ansible-pgbackrest-ssh-keys"
-
-pgbackrest_ssh_pub_keys_to_import: []
-#  - src_host: 192.168.15.21
-#    authorized_keys_path: "{{ pgbackrest_user_home }}/.ssh/authorized_keys" # destination on current inventory_hostname
-#    owner: "{{ pgbackrest_user }}"
-#    group: "{{ pgbackrest_user_group }}"
-
 pgbackrest_stanza_conf:
   - name: main
     content:

example/same-repo-host-as-pg/inventory/group_vars/all/vars.yml

@@ -3,65 +3,15 @@
 pgbackrest_is_pg_host: true
 pgbackrest_is_repository_host: true
 
-pgbackrest_working_directory: /tmp/build
 pgbackrest_version: 2.53
 
-pgbackrest_git_repo_release_artifact_url: "https://github.com/pgbackrest/pgbackrest/archive/release/{{ pgbackrest_version }}.tar.gz"
-
+# user not created on pg-host, re-using postgres user created when setting up postgresql service
 pgbackrest_create_user: false
 pgbackrest_user: postgres
 pgbackrest_user_group: postgres
+pgbackrest_user_home: "/var/lib/postgresql"
 
-pgbackrest_conf_template: "etc/pgbackrest/pgbackrest.conf.j2"
-pgbackrest_config_path: "{{ pgbackrest_config_dir }}/pgbackrest.conf"
-pgbackrest_config_dir: "/etc/pgbackrest"
-pgbackrest_cert_directory: "{{ pgbackrest_config_dir }}/cert"
-
-pgbackrest_service_template: "etc/systemd/system/pgbackrest.service.j2"
-pgbackrest_service_path: "/etc/systemd/system/pgbackrest.service"
-
-pgbackrest_setup_certificate: false
-pgbackrest_certificate_ca:
-pgbackrest_certificate_files:
-
-pgbackrest_pre_install_packages:
-  - wget
-  - tar
-
-pgbackrest_install_packages:
-  - python3-distutils
-  - meson
-  - gcc
-  - libpq-dev
-  - libssl-dev
-  - libxml2-dev
-  - pkg-config
-  - liblz4-dev
-  - libzstd-dev
-  - libbz2-dev
-  - libz-dev
-  - libyaml-dev
-  - libssh2-1-dev
-
-pgbackrest_cleanup_packages:
-  - python3-distutils
-  - meson
-  - gcc
-  - libpq-dev
-  - libssl-dev
-  - libxml2-dev
-  - pkg-config
-  - liblz4-dev
-  - libzstd-dev
-  - libbz2-dev
-  - libz-dev
-  - libyaml-dev
-  - libssh2-1-dev
-
-pgbackrest_binary_dir: /usr/bin
-pgbackrest_log_directory: /var/log/pgbackrest
-
-pgbackrest_cleanup_after_setup: false
+pgbackrest_cleanup_after_setup: true
 
 pgbackrest_repo_directories:
   - /var/lib/pgbackrest