overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8758 Commits
11 Branches
247 MiB
 
 
Tree: ab30390bd4
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ab30390bd4'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-bridge-hookshot/tasks/validate_config.yml

118 lines
6.2 KiB
Raw Blame History 

  1. # SPDX-FileCopyrightText: 2024 MDAD Team and contributors

  2. #

  3. # SPDX-License-Identifier: AGPL-3.0-or-later

  4. 

  5. ---

  6. 

  7. - name: (Deprecation) Catch and report renamed Hookshot variables

  8.   ansible.builtin.fail:

  9.     msg: >-

  10.       Your configuration contains a variable, which now has a different name.

  11.       Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).

  12.   when: "item.old in vars"

  13.   with_items:

  14.     - {'old': 'matrix_hookshot_feeds_interval', 'new': 'matrix_hookshot_feeds_pollIntervalSeconds'}

  15.     - {'old': 'matrix_hookshot_generic_urlprefix', 'new': 'matrix_hookshot_generic_urlPrefix'}

  16.     - {'old': 'matrix_hookshot_generic_allow_js_transformation_functions', 'new': 'matrix_hookshot_generic_allowJsTransformationFunctions'}

  17.     - {'old': 'matrix_hookshot_generic_user_id_prefix', 'new': 'matrix_hookshot_generic_userIdPrefix'}

  18.     - {'old': 'matrix_hookshot_github_secret', 'new': 'matrix_hookshot_github_webhook_secret'}

  19.     - {'old': 'matrix_hookshot_github_appid', 'new': 'matrix_hookshot_github_auth_id'}

  20.     - {'old': 'matrix_hookshot_github_oauth_id', 'new': 'matrix_hookshot_github_oauth_client_id'}

  21.     - {'old': 'matrix_hookshot_github_oauth_secret', 'new': 'matrix_hookshot_github_oauth_client_secret'}

  22.     - {'old': 'matrix_hookshot_github_oauth_uri', 'new': 'matrix_hookshot_github_oauth_redirect_uri'}

  23.     - {'old': 'matrix_hookshot_github_ignore_hooks', 'new': 'matrix_hookshot_github_defaultOptions_ignoreHooks'}

  24.     - {'old': 'matrix_hookshot_github_command_prefix', 'new': 'matrix_hookshot_github_defaultOptions_commandPrefix'}

  25.     - {'old': 'matrix_hookshot_github_showIssueRoomLink', 'new': 'matrix_hookshot_github_defaultOptions_showIssueRoomLink'}

  26.     - {'old': 'matrix_hookshot_github_pr_diff', 'new': 'matrix_hookshot_github_defaultOptions_prDiff'}

  27.     - {'old': 'matrix_hookshot_github_including_labels', 'new': 'matrix_hookshot_github_defaultOptions_includingLabels'}

  28.     - {'old': 'matrix_hookshot_github_excluding_labels', 'new': 'matrix_hookshot_github_defaultOptions_excludingLabels'}

  29.     - {'old': 'matrix_hookshot_github_hotlink_prefix', 'new': 'matrix_hookshot_github_defaultOptions_hotlinkIssues_prefix'}

  30.     - {'old': 'matrix_hookshot_jira_secret', 'new': 'matrix_hookshot_jira_webhook_secret'}

  31.     - {'old': 'matrix_hookshot_jira_oauth_id', 'new': 'matrix_hookshot_jira_oauth_client_id'}

  32.     - {'old': 'matrix_hookshot_jira_oauth_secret', 'new': 'matrix_hookshot_jira_oauth_client_secret'}

  33.     - {'old': 'matrix_hookshot_jira_oauth_uri', 'new': 'matrix_hookshot_jira_oauth_client_secret'}

  34.     - {'old': 'matrix_hookshot_gitlab_secret', 'new': 'matrix_hookshot_gitlab_webhook_secret'}

  35.     - {'old': 'matrix_hookshot_ident', 'new': 'matrix_hookshot_identifier'}

  36.     - {'old': 'matrix_hookshot_queue_host', 'new': 'matrix_hookshot_cache_redis_host'}

  37.     - {'old': 'matrix_hookshot_queue_port', 'new': 'matrix_hookshot_cache_redis_port'}

  38.     - {'old': 'matrix_hookshot_experimental_encryption_enabled', 'new': 'matrix_hookshot_encryption_enabled'}

  39. 

  40. - name: Fail if required Hookshot settings not defined

  41.   ansible.builtin.fail:

  42.     msg: >-

  43.       You need to define a required configuration setting (`{{ item }}`).

  44.   when: "vars[item] == ''"

  45.   with_items:

  46.     - "matrix_hookshot_appservice_token"

  47.     - "matrix_hookshot_homeserver_address"

  48.     - "matrix_hookshot_homeserver_token"

  49.     - "matrix_hookshot_container_network"

  50. 

  51. - name: Fail if required GitHub settings not defined

  52.   ansible.builtin.fail:

  53.     msg: >-

  54.       You need to define a required configuration setting (`{{ item }}`) to enable GitHub.

  55.   when: "matrix_hookshot_github_enabled and vars[item] == ''"

  56.   with_items:

  57.     - "matrix_hookshot_github_auth_id"

  58.     - "matrix_hookshot_github_webhook_secret"

  59. 

  60. - name: Fail if required GitHub OAuth settings not defined

  61.   ansible.builtin.fail:

  62.     msg: >-

  63.       You need to define a required configuration setting (`{{ item }}`) to enable GitHub OAuth.

  64.   when: "matrix_hookshot_github_oauth_enabled and vars[item] == ''"

  65.   with_items:

  66.     - "matrix_hookshot_github_oauth_client_id"

  67.     - "matrix_hookshot_github_oauth_client_secret"

  68. 

  69. - name: Fail if required Jira settings not defined

  70.   ansible.builtin.fail:

  71.     msg: >-

  72.       You need to define a required configuration setting (`{{ item }}`) to enable Jira.

  73.   when: "matrix_hookshot_jira_enabled and vars[item] == ''"

  74.   with_items:

  75.     - "matrix_hookshot_jira_webhook_secret"

  76. 

  77. - name: Fail if required Jira OAuth settings not defined

  78.   ansible.builtin.fail:

  79.     msg: >-

  80.       You need to define a required configuration setting (`{{ item }}`) to enable Jira OAuth.

  81.   when: "matrix_hookshot_jira_oauth_enabled and vars[item] == ''"

  82.   with_items:

  83.     - "matrix_hookshot_jira_oauth_client_id"

  84.     - "matrix_hookshot_jira_oauth_client_secret"

  85. 

  86. - name: Fail if required Figma settings not defined

  87.   ansible.builtin.fail:

  88.     msg: >-

  89.       You need to define at least one Figma instance in `matrix_hookshot_figma_instances` to enable Figma.

  90.   when: "matrix_hookshot_figma_enabled and matrix_hookshot_figma_instances | length == 0"

  91. 

  92. - name: Fail if required provisioning settings not defined

  93.   ansible.builtin.fail:

  94.     msg: >-

  95.       You need to define a required configuration setting (`{{ item }}`) to enable provisioning.

  96.   when: "matrix_hookshot_provisioning_enabled and vars[item] == ''"

  97.   with_items:

  98.     - "matrix_hookshot_provisioning_secret"

  99. 

  100. - name: Fail if no Redis queue enabled when Hookshot encryption is enabled

  101.   ansible.builtin.fail:

  102.     msg: >-

  103.       You need to define a required configuration setting (`matrix_hookshot_cache_redis*`) to enable Hookshot encryption.

  104.   when: "matrix_hookshot_encryption_enabled and matrix_hookshot_cache_redisUri == ''"

  105. 

  106. - name: (Deprecation) Catch and report old metrics usage

  107.   ansible.builtin.fail:

  108.     msg: >-

  109.       Your configuration contains a variable (`{{ item }}`), which refers to the old metrics collection system for Hookshot,

  110.       which exposed metrics on `https://stats.example.com/hookshot/metrics`.

  111. 

  112.       We now recommend exposing Hookshot metrics in another way, from another URL.

  113.       Refer to the changelog for more details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#2022-06-22

  114.   with_items:

  115.     - matrix_hookshot_proxy_metrics

  116.     - matrix_hookshot_metrics_endpoint

  117.   when: "item in vars"