Improve naming

Ndpnt · Ndpnt · commit c6662cacd576 · 2025-12-18T10:21:56.000+01:00
diff --git a/playbooks/deploy.yml b/playbooks/deploy.yml
@@ -50,36 +50,36 @@
             apply:
               tags: [always]
           vars:
-            ota_apps_read_config_only: true
+            ota_collection_read_config_only: true
 
         - name: Set OTA collection variables
           ansible.builtin.set_fact:
-            ota_chromium_required: "{{ ota_apps_config['@opentermsarchive/engine'] is defined }}"
+            ota_chromium_required: "{{ ota_collection_config['@opentermsarchive/engine'] is defined }}"
             ota_mongo_required: >-
               {{
                 (ansible_distribution != 'Debian' or (ansible_distribution == 'Debian' and ansible_facts['architecture'] != 'aarch64'))
                 and (
-                  (ota_apps_config['@opentermsarchive/engine'].recorder.versions.storage.type is defined
-                   and ota_apps_config['@opentermsarchive/engine'].recorder.versions.storage.type == 'mongo')
+                  (ota_collection_config['@opentermsarchive/engine'].recorder.versions.storage.type is defined
+                   and ota_collection_config['@opentermsarchive/engine'].recorder.versions.storage.type == 'mongo')
                   or
-                  (ota_apps_config['@opentermsarchive/engine'].recorder.snapshots.storage.type is defined
-                   and ota_apps_config['@opentermsarchive/engine'].recorder.snapshots.storage.type == 'mongo')
+                  (ota_collection_config['@opentermsarchive/engine'].recorder.snapshots.storage.type is defined
+                   and ota_collection_config['@opentermsarchive/engine'].recorder.snapshots.storage.type == 'mongo')
                 ) | bool
               }}
-            ota_snapshots_repository: "{{ ota_apps_config['@opentermsarchive/engine'].recorder.snapshots.storage.git.repository | default(None) }}"
-            ota_snapshots_relative_path: "{{ ota_apps_config['@opentermsarchive/engine'].recorder.snapshots.storage.git.path | default(None) }}"
-            ota_versions_repository: "{{ ota_apps_config['@opentermsarchive/engine'].recorder.versions.storage.git.repository | default(None) }}"
-            ota_versions_relative_path: "{{ ota_apps_config['@opentermsarchive/engine'].recorder.versions.storage.git.path | default(None) }}"
-            ota_collection_api_base_path: "{{ ota_apps_config['@opentermsarchive/engine']['collection-api'].basePath | default(None) }}"
-            ota_collection_api_port: "{{ ota_apps_config['@opentermsarchive/engine']['collection-api'].port | default(None) }}"
+            ota_snapshots_repository: "{{ ota_collection_config['@opentermsarchive/engine'].recorder.snapshots.storage.git.repository | default(None) }}"
+            ota_snapshots_relative_path: "{{ ota_collection_config['@opentermsarchive/engine'].recorder.snapshots.storage.git.path | default(None) }}"
+            ota_versions_repository: "{{ ota_collection_config['@opentermsarchive/engine'].recorder.versions.storage.git.repository | default(None) }}"
+            ota_versions_relative_path: "{{ ota_collection_config['@opentermsarchive/engine'].recorder.versions.storage.git.path | default(None) }}"
+            ota_collection_api_base_path: "{{ ota_collection_config['@opentermsarchive/engine']['collection-api'].basePath | default(None) }}"
+            ota_collection_api_port: "{{ ota_collection_config['@opentermsarchive/engine']['collection-api'].port | default(None) }}"
             # Generic variables for pm2 and nginx
             ota_app_directory: "{{ ota_directory }}"
             ota_app_collection_id: "{{ ota_collection_id }}"
             ota_app_pm2_home: "{{ ota_pm2_home }}"
             ota_app_endpoints:
               - name: "collection-api"
-                basePath: "{{ ota_apps_config['@opentermsarchive/engine']['collection-api'].basePath | default(None) }}"
-                port: "{{ ota_apps_config['@opentermsarchive/engine']['collection-api'].port | default(None) }}"
+                basePath: "{{ ota_collection_config['@opentermsarchive/engine']['collection-api'].basePath | default(None) }}"
+                port: "{{ ota_collection_config['@opentermsarchive/engine']['collection-api'].port | default(None) }}"
 
         - name: Setup GitHub bot SSH key
           ansible.builtin.include_role:
@@ -97,7 +97,7 @@
             apply:
               tags: [always]
           vars:
-            ota_contribution_tool_apps_read_config_only: true
+            ota_contribution_tool_read_config_only: true
 
         - name: Set contribution-tool variables
           ansible.builtin.set_fact:
@@ -125,22 +125,22 @@
             apply:
               tags: [always]
           vars:
-            ota_federation_api_apps_read_config_only: true
+            ota_federation_api_read_config_only: true
 
         - name: Set federation-api variables
           ansible.builtin.set_fact:
             ota_chromium_required: false
             ota_mongo_required: false
-            ota_federation_api_port: "{{ ota_federation_api_apps_config['@opentermsarchive/federation-api'].port }}"
-            ota_federation_api_base_path: "{{ ota_federation_api_apps_config['@opentermsarchive/federation-api'].basePath }}"
+            ota_federation_api_port: "{{ ota_federation_api_config['@opentermsarchive/federation-api'].port }}"
+            ota_federation_api_base_path: "{{ ota_federation_api_config['@opentermsarchive/federation-api'].basePath }}"
             # Generic variables for pm2 and nginx
             ota_app_directory: "{{ ota_federation_api_directory }}"
             ota_app_collection_id: "{{ ota_federation_api_collection_id }}"
             ota_app_pm2_home: "{{ ota_federation_api_pm2_home }}"
             ota_app_endpoints:
               - name: "federation-api"
-                basePath: "{{ ota_federation_api_apps_config['@opentermsarchive/federation-api'].basePath }}"
-                port: "{{ ota_federation_api_apps_config['@opentermsarchive/federation-api'].port }}"
+                basePath: "{{ ota_federation_api_config['@opentermsarchive/federation-api'].basePath }}"
+                port: "{{ ota_federation_api_config['@opentermsarchive/federation-api'].port }}"
 
     # Infrastructure installation (common)
     - name: Install infrastructure
@@ -235,7 +235,7 @@
         apply:
           become: true
       vars:
-        ota_nginx_collection_id: "{{ ota_app_collection_id }}"
+        ota_nginx_app_id: "{{ ota_app_collection_id }}"
         ota_nginx_endpoints: "{{ ota_app_endpoints }}"
         ota_nginx_config_template: ./templates/nginx.conf.j2
         ota_nginx_reverse_proxy_config_template: ./templates/nginx-reverse-proxy-conf.j2
diff --git a/playbooks/templates/nginx-reverse-proxy-conf.j2 b/playbooks/templates/nginx-reverse-proxy-conf.j2
@@ -1,12 +1,12 @@
 {{ ansible_managed | comment }}
 
-# Collection: {{ ota_nginx_collection_id }}
+# Application: {{ ota_nginx_app_id }}
 
 {% for endpoint in ota_nginx_endpoints %}
 {% if endpoint.basePath and endpoint.port %}
 location {{ endpoint.basePath }} {
     # Allowing for a `burst` of requests beyond the specified rate limit. The `nodelay` parameter ensures that excessive requests beyond the burst limit are immediately rejected with a 429 error response instead of being queued. See https://www.nginx.com/blog/rate-limiting-nginx/.
-    limit_req zone=ota_limited_{{ ota_nginx_collection_id }} burst={{ ota_rate_limit_burst | default(5) }} nodelay;
+    limit_req zone=ota_limited_{{ ota_nginx_app_id }} burst={{ ota_rate_limit_burst | default(5) }} nodelay;
     proxy_pass http://localhost:{{ endpoint.port }};
     proxy_redirect off;
     proxy_set_header Host $host;
diff --git a/playbooks/templates/nginx-server.conf.j2 b/playbooks/templates/nginx-server.conf.j2
@@ -4,6 +4,6 @@ server {
     listen 80;
     server_name {{ inventory_hostname }};
 
-    # Include all OTA collection location configs
+    # Include all OTA applications location configs
     include /etc/nginx/ota.d/*.conf;
 }
diff --git a/playbooks/templates/nginx.conf.j2 b/playbooks/templates/nginx.conf.j2
@@ -1,5 +1,5 @@
 {{ ansible_managed | comment }}
 
-# Collection: {{ ota_nginx_collection_id }}
-# Configure the collection-specific rate limiting zone to prevent DDoS attacks.
-limit_req_zone $binary_remote_addr zone=ota_limited_{{ ota_nginx_collection_id }}:{{ ota_rate_limit_zone_size | default('10m') }} rate={{ ota_rate_limit_rate | default('10r/s') }};
+# Application: {{ ota_nginx_app_id }}
+# Configure app-specific rate limiting zone to prevent DDoS attacks.
+limit_req_zone $binary_remote_addr zone=ota_limited_{{ ota_nginx_app_id }}:{{ ota_rate_limit_zone_size | default('10m') }} rate={{ ota_rate_limit_rate | default('10r/s') }};
diff --git a/roles/github/README.md b/roles/github/README.md
@@ -6,7 +6,7 @@ Sets up GitHub bot SSH key for repository access.
 
 | Variable | Description | Default |
 |----------|-------------|---------|
-| `ota_github_bot_key_path` | Path to store SSH key on server | `/home/{{ ansible_user }}/.ssh/ota-github-bot-key-{{ ota_collection_id }}` |
+| `ota_github_bot_key_path` | Path to store SSH key on server | `/home/{{ ansible_user }}/.ssh/ota-github-bot-key-{{ ota_app_collection_id }}` |
 
 ## Files Required
 
@@ -15,4 +15,4 @@ Sets up GitHub bot SSH key for repository access.
 ## Notes
 
 - Adds GitHub SSH fingerprints to known_hosts
-- Supports collection-scoped keys for multi-tenant deployment
+- Supports app-scoped keys for multi-tenant deployment
diff --git a/roles/github/tasks/main.yml b/roles/github/tasks/main.yml
@@ -5,7 +5,7 @@
   register: github_bot_private_key_file
   delegate_to: localhost
 
-- name: Add GitHub Bot SSH key (collection-scoped)
+- name: Add GitHub Bot SSH key (app-scoped)
   when: github_bot_private_key_file.stat.exists | default(false)
   ansible.builtin.copy:
     src: "{{ inventory_dir }}/github-bot-private-key"
diff --git a/roles/nginx/configure/README.md b/roles/nginx/configure/README.md
@@ -6,7 +6,7 @@ Configures NGINX reverse proxy for OTA applications.
 
 | Variable | Description | Default |
 |----------|-------------|---------|
-| `ota_nginx_collection_id` | Collection identifier for config files | Required |
+| `ota_nginx_app_id` | Application identifier for config files | Required |
 | `ota_nginx_endpoints` | List of endpoints with basePath and port | Required |
 | `ota_nginx_config_template` | Rate limit config template path | Required |
 | `ota_nginx_reverse_proxy_config_template` | Reverse proxy config template path | Required |
diff --git a/roles/nginx/configure/tasks/main.yml b/roles/nginx/configure/tasks/main.yml
@@ -21,10 +21,10 @@
         mode: "0644"
         force: true
 
-    - name: Add collection-specific rate limit config
+    - name: Add app-specific rate limit config
       ansible.builtin.template:
         src: "{{ ota_nginx_config_template }}"
-        dest: /etc/nginx/conf.d/ota-rate-limit-{{ ota_nginx_collection_id }}.conf
+        dest: /etc/nginx/conf.d/ota-rate-limit-{{ ota_nginx_app_id }}.conf
         owner: root
         group: root
         mode: "0644"
@@ -38,13 +38,13 @@
         group: root
         mode: "0755"
 
-- name: Configure NGINX for collection
+- name: Configure NGINX for application
   notify: Restart NGINX
   block:
-    - name: Add collection-specific location config
+    - name: Add app-specific location config
       ansible.builtin.template:
         src: "{{ ota_nginx_reverse_proxy_config_template }}"
-        dest: /etc/nginx/ota.d/{{ ota_nginx_collection_id }}.conf
+        dest: /etc/nginx/ota.d/{{ ota_nginx_app_id }}.conf
         mode: "0644"
         force: true
 
@@ -57,7 +57,7 @@
         mode: "0644"
         force: true
 
-    - name: Enable OTA collection site
+    - name: Enable OTA site
       ansible.builtin.file:
         src: /etc/nginx/sites-available/ota
         dest: /etc/nginx/sites-enabled/ota
diff --git a/roles/ota/collection/defaults/main.yml b/roles/ota/collection/defaults/main.yml
@@ -1,5 +1,5 @@
 ---
-ota_apps_read_config_only: false
+ota_collection_read_config_only: false
 ota_collection_repository_branch: main
 ota_directory: "{{ ota_collection_repository | ansible.builtin.urlsplit('path') | ansible.builtin.basename | ansible.builtin.splitext | first }}" # extract the repository name from the URL
 ota_collection_id: "{{ ota_directory | regex_replace('-declarations$', '') }}"
diff --git a/roles/ota/collection/tasks/main.yml b/roles/ota/collection/tasks/main.yml
@@ -14,10 +14,10 @@
 
 - name: Save production config data into a variable
   ansible.builtin.set_fact:
-    ota_apps_config: "{{ read_config.stdout | from_json }}"
+    ota_collection_config: "{{ read_config.stdout | from_json }}"
 
 - name: Set up environment variables and install dependencies
-  when: not ota_apps_read_config_only | bool
+  when: not ota_collection_read_config_only | bool
   block:
     - name: Install dependencies
       ansible.builtin.command:
diff --git a/roles/ota/contribution-tool/defaults/main.yml b/roles/ota/contribution-tool/defaults/main.yml
@@ -1,5 +1,5 @@
 ---
-ota_contribution_tool_apps_read_config_only: false
+ota_contribution_tool_read_config_only: false
 ota_contribution_tool_repository_branch: main
 # Allow override of directory name for multi-instance deployment
 # If not set, extract from repository URL
diff --git a/roles/ota/contribution-tool/tasks/main.yml b/roles/ota/contribution-tool/tasks/main.yml
@@ -57,10 +57,10 @@
     version: "{{ ota_contribution_tool_repository_branch }}"
     force: true
     depth: 1
-  when: not ota_contribution_tool_apps_read_config_only | bool
+  when: not ota_contribution_tool_read_config_only | bool
 
 - name: Set up environment variables, install dependencies and build
-  when: not ota_contribution_tool_apps_read_config_only | bool
+  when: not ota_contribution_tool_read_config_only | bool
   block:
     - name: Copy .env file to server (decrypts if vault-encrypted)
       ansible.builtin.copy:
diff --git a/roles/ota/federation-api/defaults/main.yml b/roles/ota/federation-api/defaults/main.yml
@@ -1,5 +1,5 @@
 ---
-ota_federation_api_apps_read_config_only: false
+ota_federation_api_read_config_only: false
 ota_federation_api_instance_repository_branch: main
 # Allow override of directory name for multi-instance deployment
 # If not set, extract from repository URL
diff --git a/roles/ota/federation-api/tasks/main.yml b/roles/ota/federation-api/tasks/main.yml
@@ -13,10 +13,10 @@
 
 - name: Save production config data into a variable
   ansible.builtin.set_fact:
-    ota_federation_api_apps_config: "{{ ota_read_config.stdout | from_json }}"
+    ota_federation_api_config: "{{ ota_read_config.stdout | from_json }}"
 
 - name: Set up environment variables and install dependencies
-  when: not ota_federation_api_apps_read_config_only | bool
+  when: not ota_federation_api_read_config_only | bool
   block:
     - name: Check if instance-specific .env file exists
       ansible.builtin.stat:

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@ server {`
`4`	`4`	`listen 80;`
`5`	`5`	`server_name {{ inventory_hostname }};`
`6`	`6`
`7`		`- # Include all OTA collection location configs`
	`7`	`+ # Include all OTA applications location configs`
`8`	`8`	`include /etc/nginx/ota.d/*.conf;`
`9`	`9`	`}`