added READMEs + updated variable names

Author: wtripp180901

ansible/roles/dnf_repos/README.md

@@ -0,0 +1,46 @@
+dnf_repos
+=========
+
+Modifies repo definitions for repofiles in `/etc/yum.repos.d` to point to snapshots in StackHPC's Ark Pulp server.
+
+Requirements
+------------
+
+Requires Ark credentials.
+
+Role Variables
+--------------
+
+Variables in this role are also required by `pulp_site` so set in 
+`environments/common/inventory/groups_vars/all/dnf_repos.yml`. See that file for detailed default values.
+
+- `dnf_repos_all`: Dict of dicts containing information to construct URLs for timestamped repos from Ark for each Rocky version. For example:
+    ```
+    dnf_repos_all:
+        appstream:                          # yum_repository:name
+            '8.10':                           # ansible_distribution_version or ansible_distribution_major_version
+                repo_file: Rocky-AppStream      # yum_repository: file
+                # repo_name:                    # optional, override yum_repository:name
+                pulp_path: rocky/8.10/AppStream/x86_64/os
+                pulp_timestamp: 20250614T013846
+                # pulp_content_url:             # optional, dnf_repos_pulp_content_url
+            '9.6':
+                ...
+    ```
+- `dnf_repos_default`: Appliance default repos to use Ark snapshots for. Follows same format as
+  `dnf_repos_all`, but includes top level keys to allow repos to be conditionally included in 
+  `dnf_repos_all`. See `environments/common/inventory/group_vars/all/dnf_repos.yml` and
+  `environments/common/inventory/group_vars/all/timestamps.yml` for full templating logic.
+- `dnf_repos_extra`: Additional repos to use Ark snapshots for. Follows same format as
+  `dnf_repos_all`. Defaults to `{}`
+- `dnf_repos_no_epel`: Dict of all repos included in `dnf_repos_all` excluding 
+  `epel`, used to prevent conflicts with repofile installed by `epel-release`
+- `dnf_repos_default_epel`: Dict of repos objects following same format as `dnf_repos_all` but only 
+   including `epel` repo. 
+- `dnf_repos_pulp_content_url`: Optional str. Content URL of Pulp server to use Ark snapshots from. 
+  Should be overriden if using local Pulp server instead of upstream Ark Pulp (See
+  `ansible/roles/pulp_site`). Defaults to `{{ appliances_pulp_url }}/pulp/content`
+- `dnf_repos_username`: Optional str. Username for Ark. Should be set if using upstream StackHPC Ark
+  Pulp server, but omitted if using local Pulp server (see `ansible/roles/pulp_site`)
+- `dnf_repos_password`: Optional str. Password for Ark. Should be set if using upstream StackHPC Ark
+  Pulp server, but omitted if using local Pulp server (see `ansible/roles/pulp_site`)

ansible/roles/pulp_site/README.md

@@ -0,0 +1,35 @@
+pulp_site
+=========
+
+Contains playbooks to deploy a Pulp server and sync its content with repo snapshots in
+StackHPC's Ark Pulp server
+
+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).
+
+Role Variables
+--------------
+
+- `pulp_site_url`: Required str. The base url from which Pulp content will be hosted. Defaults to `{{ appliances_pulp_url }}`. 
+                 Value to set for ``appliances_pulp_url` will be generated and output by the deploy.yml playbook.
+- `pulp_site_port`: Optional str. Port to serve Pulp server on. Defaults to `8080`.
+- `pulp_site_username`: Optional str. Admin username for the Pulp server. Defaults to `admin`.
+- `pulp_site_password`: Required str. Admin password for the Pulp server. Defaults to `{{ vault_pulp_admin_password }}`.
+- `pulp_site_upstream_username`: Required str. Username for accessing content from the upstream Ark Pulp server.
+- `pulp_site_upstream_password`: Required str. Password for upstream Ark Pulp server.
+- `pulp_site_upstream_content_url`: Optional str. Content URL of upstream Ark Pulp. Defaults to `https://ark.stackhpc.com/pulp/content`.
+- `pulp_site_install_dir`: Optional str. Directory on Pulp host to install config and persistent state to be mounted into Pulp container. Defaults to `/home/rocky/pulp`.
+- `pulp_site_target_facts`: Optional str. The `ansible_facts` of a host which will be pulling from your Pulp server, allowing the role to auto-discover the necessary repos to pull.
+                          defaults to `{{ hostvars[groups['pulp'][0]]['ansible_facts'] }}`.
+- `pulp_site_target_distribution_version`: Optional str. The Rocky Linux minor release to sync repos from Ark for. Defaults to `{{ pulp_site_target_facts['distribution_version'] }}`.
+- `pulp_site_rpm_repo_defaults`: Optional dict. Contains key value pairs for fields which are common to all repo definition in `pulp_site_rpm_repos`. Includes values for `remote_username`,
+                               `remote_password` and `policy` by default.
+- `pulp_site_rpm_repos`: Optional list of dicts. List of repo definitions in format required by the `stackhpc.pulp.pulp_repository`. Defaults to modified versions of repos defined in
+                       `dnf_repos_all`.
+- `pulp_site_rpm_publications`: Optional list of dicts. List of repo definitions in format required by the `stackhpc.pulp.pulp_publication`. Defaults to list of publications for repos defined in
+                              `dnf_repos_all`.
+- `pulp_site_rpm_distributions`: Optional list of dicts. List of repo definitions in format required by the `stackhpc.pulp.pulp_distribution`. Defaults to list of distributions for repos defined in
+                              `dnf_repos_all`.

ansible/roles/pulp_site/defaults/main.yml

@@ -7,7 +7,7 @@ pulp_site_password: "{{ vault_pulp_admin_password }}"
 # pulp_site_upstream_password:
 pulp_site_upstream_content_url: https://ark.stackhpc.com/pulp/content
 pulp_site_install_dir: '/home/rocky/pulp'
-pulp_site_selinux_suffix: "{{ ':Z' if ansible_selinux.status == 'enabled' else '' }}"
+_pulp_site_selinux_suffix: "{{ ':Z' if ansible_selinux.status == 'enabled' else '' }}"
 pulp_site_target_facts: "{{ hostvars[groups['pulp'][0]]['ansible_facts'] }}"
 pulp_site_target_distribution_version: "{{ pulp_site_target_facts['distribution_version'] }}" # TODO: how to set automatically?
 
@@ -16,16 +16,16 @@ pulp_site_rpm_repo_defaults:
   remote_password: "{{ pulp_site_upstream_password }}"
   policy: on_demand
 
-pulp_site_rpm_info: |
+_pulp_site_rpm_info: |
   {{
     dnf_repos_all |
     select_repos(pulp_site_target_distribution_version)
   }}
 pulp_site_rpm_repos: |
   {{
-    pulp_site_rpm_info |
+    _pulp_site_rpm_info |
     to_rpm_repos(pulp_site_upstream_content_url, pulp_site_rpm_repo_defaults)
   }}
 
-pulp_site_rpm_publications: "{{ pulp_site_rpm_info | to_rpm_pubs }}"
-pulp_site_rpm_distributions: "{{ pulp_site_rpm_info | to_rpm_distros }}"
+pulp_site_rpm_publications: "{{ _pulp_site_rpm_info | to_rpm_pubs }}"
+pulp_site_rpm_distributions: "{{ _pulp_site_rpm_info | to_rpm_distros }}"

ansible/roles/pulp_site/tasks/install.yml

@@ -26,10 +26,10 @@
     publish:
       - "{{ pulp_site_port }}:80"
     volume:
-    - "{{ pulp_site_install_dir }}/settings:/etc/pulp{{ pulp_site_selinux_suffix }}"
-    - "{{ pulp_site_install_dir }}/pulp_storage:/var/lib/pulp{{ pulp_site_selinux_suffix }}"
-    - "{{ pulp_site_install_dir }}/pgsql:/var/lib/pgsql{{ pulp_site_selinux_suffix }}"
-    - "{{ pulp_site_install_dir }}/containers:/var/lib/containers{{ pulp_site_selinux_suffix }}"
+    - "{{ pulp_site_install_dir }}/settings:/etc/pulp{{ _pulp_site_selinux_suffix }}"
+    - "{{ pulp_site_install_dir }}/pulp_storage:/var/lib/pulp{{ _pulp_site_selinux_suffix }}"
+    - "{{ pulp_site_install_dir }}/pgsql:/var/lib/pgsql{{ _pulp_site_selinux_suffix }}"
+    - "{{ pulp_site_install_dir }}/containers:/var/lib/containers{{ _pulp_site_selinux_suffix }}"
     device: /dev/fuse
     image: docker.io/pulp/pulp:3.68.1
     state: present

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

@@ -15,7 +15,6 @@ dnf_repos_default_epel: "{{ dnf_repos_default['epel'] }}"
 #         pulp_path: rocky/8.10/AppStream/x86_64/os
 #         pulp_timestamp: 20250614T013846
 #         # pulp_content_url:             # optional, dnf_repos_pulp_content_url
-#         pulp_repo_name: appstream       # pulp repository name
 
 # Should be in same format as dnf_repos_default, except without the top level indexing keys e.g
 # dnf_repos_extra: