Merge pull request #428 from pneerincx/fix/mkdocs

Fix/mkdocs
rug-cit-hpc · Jul 5, 2021 · 44b1510 · 44b1510
2 parents 5fe3fd3 + 191dca0
commit 44b1510
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 2 deletions.
diff --git a/roles/online_docs/defaults/main.yml b/roles/online_docs/defaults/main.yml
@@ -0,0 +1,5 @@
+---
+external_hrefs:
+  spacewalk: 'https://spacewalkproject.github.io/'
+  pulp: 'https://pulpproject.org/'
+...
diff --git a/roles/online_docs/tasks/main.yml b/roles/online_docs/tasks/main.yml
@@ -60,6 +60,27 @@
   check_mode: false
   register: 'lmod_version'
 
+- name: "Find all ip_addresses.yml files in {{ playbook_dir }}/group_vars/*."
+  find:
+    paths: "{{ playbook_dir }}/group_vars/"
+    recurse: true
+    patterns: 'ip_addresses.yml'
+  register: ip_addresses_files
+  delegate_to: localhost
+
+- name: 'Include variables from all ip_addresses.yml files.'
+  include_vars:
+    file: "{{ item }}"
+    name: "networking_lookup"
+  with_items: "{{ ip_addresses_files.files | map (attribute='path') | list }}"
+  register: networking_lookups
+  delegate_to: localhost
+
+- name: 'Combine network info from ip_addresses.yml files into one dict.'
+  set_fact:
+    networking_lookups: "{{ networking_lookups.results | json_query('[].ansible_facts.networking_lookup.ip_addresses') | combine() }}"
+  delegate_to: localhost
+
 - name: 'Set selinux in permissive mode.'
   selinux:
     policy: 'targeted'

diff --git a/roles/online_docs/templates/mkdocs/docs/cluster.md b/roles/online_docs/templates/mkdocs/docs/cluster.md
@@ -10,7 +10,7 @@ The jobs are submitted to a workload manager, which distributes them efficiently
 
 The key features of the {{ slurm_cluster_name | capitalize }} cluster include:
 
- * Linux OS: [CentOS](https://www.centos.org/) 7.x with [Spacewalk](https://spacewalkproject.github.io/) for package distribution/management.
+ * Linux OS: [CentOS](https://www.centos.org/) 7.x with [{{ repo_manager | capitalize }}]({{ external_hrefs[repo_manager] }}) for package distribution/management.
  * Completely virtualised on an [OpenStack](https://www.openstack.org/) cloud
  * Deployment of HPC cluster with [Ansible playbooks](https://docs.ansible.com/ansible/latest/index.html) under version control in a Git repo: [league-of-robots](https://github.com/rug-cit-hpc/league-of-robots)
  * Job scheduling: [Slurm Workload Manager](https://slurm.schedmd.com/)

diff --git a/roles/online_docs/templates/mkdocs/docs/specifications.md b/roles/online_docs/templates/mkdocs/docs/specifications.md
@@ -5,7 +5,7 @@
 
 Key ingredients of the High Performance Computing (HPC) environment of the {{ slurm_cluster_name | capitalize }} cluster
 
- * Linux OS: [CentOS](https://www.centos.org/) {{ hostvars[groups['user_interface'][0]]['ansible_distribution_version'] }} with [Spacewalk](https://spacewalkproject.github.io/) for package distribution/management.
+ * Linux OS: [CentOS](https://www.centos.org/) {{ hostvars[groups['user_interface'][0]]['ansible_distribution_version'] }} with [{{ repo_manager | capitalize }}]({{ external_hrefs[repo_manager] }}) for package distribution/management.
  * Job scheduling: [Slurm Workload Manager](https://slurm.schedmd.com/) {{ slurm_version.stdout }}
  * Module system: [Lmod](https://github.com/TACC/Lmod) {{ lmod_version.stdout }}
  * Deployment of (Bioinformatics) software: [EasyBuild](https://github.com/easybuilders/easybuild)

diff --git a/roles/online_docs/templates/mkdocs/mkdocs.yml b/roles/online_docs/templates/mkdocs/mkdocs.yml
@@ -1,4 +1,6 @@
 site_name: "{{ slurm_cluster_name | capitalize }} HPC cluster"
+site_url: "http://{{ networking_lookups[groups['docs'] | first | regex_replace('^' + ai_jumphost + '\\+','')].fqdn }}/{{ slurm_cluster_name }}/"
+use_directory_urls: true
 theme:
   name: readthedocs
   highlightjs: false