docs tweaks

Author: wtripp180901

ansible/adhoc/deploy-pulp.yml

@@ -1,5 +1,3 @@
-# Usage: ansible-playbook ansible/adhoc/deploy-pulp.yml -e "pulp_server=<pulp server hostname>"
-
 - name: Install pulp on server
   become: yes
   hosts: pulp_server

ansible/roles/pulp_site/README.md

@@ -8,7 +8,8 @@ Requirements
 ------------
 
 Requires Ark credentials. The VM you are deploying Pulp on must allow ingress on `pulp_site_port`
-and not be externally accessible (as the Pulp server's content is unauthenticated).
+and not be externally accessible (as the Pulp server's content is unauthenticated). Rocky Linux 9 has been
+tested as the target VM for deploying Pulp.
 
 Role Variables
 --------------

ansible/roles/pulp_site/filter_plugins/pulp-list-filters.py

@@ -7,7 +7,7 @@ def filters(self):
             'select_repos': self.select_repos,
         }
 
-    def select_repos(self, dnf_repos, target_distro_ver): #TODO: why does baseos get a major and minor version?
+    def select_repos(self, dnf_repos, target_distro_ver):
         """ Filter dnf_repos to only those for a relevant distribution version (M.m or M). Returns a list of dicts.
             Also adds pulp_repo_name field to give the repository a unique name in Pulp to be referenced by subsequent
             filters

docs/experimental/pulp.md

@@ -5,21 +5,24 @@ In order to ensure reproducible builds, the appliance can build images using rep
 ## Deploying/configuring Pulp Server
 
 ### Deploying a Pulp server
-A playbook is provided to install and configure a Pulp server on a given host. Admin credentials for this server are automatically generated through the `ansible/adhoc/generate-passwords.yml` playbook. To use this, create an inventory file defining a group `pulp_server` containing a single host, which requires at least 2 vCPUs and 4GB RAM. Deploying and syncing Pulp has been tested on an RL9 host. The hostvar `ansible_host` should be defined, giving the IP address Ansible should use for ssh. For example:
+A playbook is provided to install and configure a Pulp server on a given host. Admin credentials for this server are automatically generated through the `ansible/adhoc/generate-passwords.yml` playbook. To use this, create an inventory file
+defining a group `pulp_server` containing a single host, which requires at least 2 vCPUs and 4GB RAM. The group should be defined in your `site` environment's inventory so that a single Pulp server is shared between all environments and 
+the same snapshots are tested in staging and production.
+Deploying and syncing Pulp has been tested on an RL9 host. The hostvar `ansible_host` should be defined, giving the IP address Ansible should use for ssh. For example, you can create an ini file at `environments/site/inventory/pulp` with the contents:
 
 ```
 [pulp_server]
-pulp_host ansible_host=<VM-ip-address> # Note the host name can't conflict with group names i.e can't be called `pulp` or `pulp_server`
+pulp_host ansible_host=<VM-ip-address>
 ```
 
-Once complete, it will print a message giving a value to set for `appliances_pulp_url`, assuming the `ansible_host` address is also the address the cluster
+> [!WARNING] 
+> The inventory hostname cannot conflict with group names i.e can't be called `pulp` or `pulp_server`.
+
+Once complete, it will print a message giving a value to set for `appliances_pulp_url` (see example config below), assuming the `ansible_host` address is also the address the cluster
 should use to reach the Pulp server.
 
 Note access to this server's content isn't authenticated so this assumes the `pulp_server` host is not externally reachable.
 
-**TODO: You can actually do this using additional_nodes now, how would we make the pulp store persistant?**
-**TODO: don't advise that, we want single server for all environments**
-
 ### Using an existing Pulp server
 An existing Pulp server can be used to host Ark repos by overriding `pulp_site_password` and `appliances_pulp_url` in the target environment. Note that this assumes the same configuration as the appliance deployed Pulp i.e no content authentication.
 

environments/common/inventory/group_vars/all/dnf_repos.yml

@@ -1,4 +1,4 @@
-# dnf_repos_default: see timestamps.yml
+# dnf_repos_default: see role ansible/roles/dnf_repos/README.md for format and timestamps.yml for default definition
 
 # override this in environments/site/inventory/group_vars/dnf_repos.yml to add repos:
 dnf_repos_extra: {}