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.
 
 

109 lines
6.5 KiB

  1. # SPDX-FileCopyrightText: 2023 - 2026 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2024 Suguru Hirahara
  3. #
  4. # SPDX-License-Identifier: AGPL-3.0-or-later
  5. ---
  6. # The version that the user has validated their setup against.
  7. # When empty, the user will be prompted to set this variable.
  8. # New users should set this to the current expected version (see below).
  9. # See `examples/vars.yml` and `matrix_playbook_migration_expected_version` for the recommended value.
  10. matrix_playbook_migration_validated_version: ''
  11. # The version that the playbook expects the user to have validated against.
  12. # This is bumped whenever a breaking change is introduced.
  13. # The value configured here needs to exist in `matrix_playbook_migration_breaking_changes` as well.
  14. matrix_playbook_migration_expected_version: "v2026.03.23.0"
  15. # A list of breaking changes, used to inform users what changed between their validated version and the expected version.
  16. matrix_playbook_migration_breaking_changes:
  17. - version: "v2026.03.23.0"
  18. summary: "Initial migration validation system"
  19. changelog_url: "https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#2026-03-22"
  20. # Controls if (`matrix_prometheus_nginxlog_exporter` -> `prometheus_nginxlog_exporter`) validation will run.
  21. matrix_playbook_migration_matrix_prometheus_nginxlog_exporter_migration_validation_enabled: true
  22. # Controls if (`matrix_prometheus_node_exporter` -> `prometheus_node_exporter`) validation will run.
  23. matrix_playbook_migration_matrix_prometheus_node_exporter_migration_validation_enabled: true
  24. # Controls if (`matrix_prometheus_postgres_exporter` -> `prometheus_postgres_exporter`) validation will run.
  25. matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_validation_enabled: true
  26. # Controls if (`matrix_backup_borg` -> `backup_borg`) validation will run.
  27. matrix_playbook_migration_matrix_backup_borg_migration_validation_enabled: true
  28. # Controls if (`matrix_grafana` -> `grafana`) validation will run.
  29. matrix_playbook_migration_matrix_grafana_migration_validation_enabled: true
  30. # Controls if (`matrix_ntfy` -> `ntfy`) validation will run.
  31. matrix_playbook_migration_matrix_ntfy_migration_validation_enabled: true
  32. # Controls if (`matrix_redis` -> `redis`) validation will run.
  33. matrix_playbook_migration_matrix_redis_migration_validation_enabled: true
  34. # Controls if (`redis` -> `valkey`) validation will run.
  35. matrix_playbook_migration_redis_valkey_migration_validation_enabled: true
  36. # Controls if (`keydb` -> `valkey`) validation will run.
  37. matrix_playbook_migration_keydb_valkey_migration_validation_enabled: true
  38. # Controls if (`matrix_etherpad` -> `etherpad`) validation will run.
  39. matrix_playbook_migration_matrix_etherpad_migration_validation_enabled: true
  40. # Controls if (`matrix_aux` -> `aux`) validation will run.
  41. matrix_playbook_migration_matrix_aux_migration_validation_enabled: true
  42. # Controls if (`matrix_jitsi` -> `jitsi`) validation will run.
  43. matrix_playbook_migration_matrix_jitsi_migration_validation_enabled: true
  44. # Controls if (`matrix_bot_postmoogle_` -> `matrix_postmoogle_`) validation will run.
  45. matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled: true
  46. # Controls if the old apt repository (likely without a `signed-by` option) on Debian-based systems will be removed.
  47. #
  48. # Older versions of the Docker role (5.x, 6.x) used to install a repository at a path like: `/etc/apt/sources.list.d/download_docker_com_linux_*`
  49. # For 6.x, the repository included a `signed-by` option, but for earlier versions it did not.
  50. #
  51. # New versions of the Docker role (7.0+) install a new apt repository with `signed-by` option to a different path (`/etc/apt/sources.list.d/docker.list`),
  52. # but if a non-signed-by repository exists at the old path, a conflict will arise.
  53. #
  54. # Our workaround is to just delete the old repository file. Later, when the Docker role runs, it will install a new one at the new path.
  55. #
  56. # See:
  57. # - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2999
  58. # - https://github.com/geerlingguy/ansible-role-docker/pull/410
  59. matrix_playbook_migration_debian_signedby_migration_enabled: true
  60. matrix_playbook_migration_debian_signedby_migration_repository_path: "/etc/apt/sources.list.d/download_docker_com_linux_{{ ansible_facts['distribution'] | lower }}.list"
  61. # Controls if the old apt repository for Docker (`signed-by=/etc/apt/trusted.gpg.d/docker.asc`) will be removed,
  62. # so that the Docker role (7.2.0+) can install a new non-conflicting one (`signed-by=/etc/apt/keyrings/docker.asc`).
  63. #
  64. # Without this migration, the role would choke at the "galaxy/docker : Add Docker repository." task when trying to add the repository again:
  65. # > An exception occurred during task execution. To see the full traceback, use -vvv. The error was: apt_pkg.Error: E:Conflicting values set for option Signed-By regarding source https://download.docker.com/linux/ubuntu/ focal: /etc/apt/trusted.gpg.d/docker.asc != /etc/apt/keyrings/docker.asc, E:The list of sources could not be read.
  66. #
  67. # Related to: https://github.com/geerlingguy/ansible-role-docker/pull/436
  68. matrix_playbook_migration_docker_trusted_gpg_d_migration_enabled: true
  69. matrix_playbook_migration_docker_trusted_gpg_d_migration_repository_path: "/etc/apt/sources.list.d/docker.list"
  70. # Controls if variable transition checks (related to the matrix-nginx-proxy elimination) will run.
  71. # If you'd like to keep some `matrix_nginx_proxy` and other variables around and not be warned about them, disable this.
  72. # Note: this is not just about `matrix_nginx_proxy_*` variables, but about various other variables that were removed
  73. # during the matrix-nginx-proxy elimination.
  74. matrix_playbook_migration_matrix_nginx_proxy_elimination_variable_transition_checks_enabled: true
  75. # Controls if (`matrix_nginx_proxy`) leftover variable checks will run.
  76. # If you'd like to keep some `matrix_nginx_proxy` variables around and not be warned about them, disable this.
  77. matrix_playbook_migration_matrix_nginx_proxy_leftover_variable_validation_checks_enabled: true
  78. # Controls if (`matrix_ssl_`) leftover variable checks will run.
  79. matrix_playbook_migration_matrix_ssl_leftover_variable_checks_enabled: true
  80. # Controls whether this role will delete old files left over from `matrix-nginx-proxy`.
  81. # Regardless of this value, if discovered, a `matrix-nginx-proxy.service` systemd service will be stopped and removed.
  82. matrix_playbook_migration_matrix_nginx_proxy_uninstallation_enabled: true
  83. # Controls whether this role will try to detect and clean up the /matrix/ssl files.
  84. matrix_playbook_migration_matrix_ssl_uninstallation_enabled: true