Ansible Роль: Директорий Исследовательского Программного Обеспечения (RSD-as-a-service)

Настройка Директория Исследовательского Программного Обеспечения с использованием Ansible.

В настоящее время поддерживаемые платформы:

• Ubuntu 20.04 LTS
• Ubuntu 22.04 LTS

Требования

• docker (Docker SDK для Python)
• docker-compose

Переменные Роли

• rsd_dependencies
  • По умолчанию: ["docker", "docker-compose"]
  • Описание: Список необходимых модулей Python.
• rsd_working_directory
  • По умолчанию: "/opt/rsd"
  • Описание: Путь, где будет размещён репозиторий RSD.
• rsd_version
  • По умолчанию: "latest"
  • Описание: Какую версию образов контейнера RSD-as-a-service развернуть (имя тега образа). Если используете latest, образы контейнера всегда будут скачиваться перед запуском приложения.
• rsd_container_registry_path
  • По умолчанию: "ghcr.io/hifis-net/rsd-saas"
  • Описание: Путь к реестру контейнеров, откуда скачиваются образы.
• rsd_environment_file
  • По умолчанию: "rsd-secrets.env"
  • Описание: Конкретный файл окружения для инвентаря.
• rsd_docker_compose_cmd
  • По умолчанию: "docker-compose"
  • Описание: Команда Docker Compose, используемая для проверки docker-compose.yml.
• rsd_docker_compose_template_file
  • По умолчанию: "docker-compose.yml.j2"
  • Описание: Шаблонный файл для docker-compose.yml.
• rsd_nginx_config_template
  • По умолчанию: "nginx.conf.j2"
  • Описание: Шаблонный файл для конфигурации Nginx.
• rsd_tls_cert_path
  • По умолчанию: "/etc/ssl/certs/rsd.pem"
  • Описание: Абсолютный путь назначения для файла TLS сертификата.
• rsd_tls_key_path
  • По умолчанию: "/etc/ssl/private/rsd.key"
  • Описание: Абсолютный путь назначения для файла TLS ключа.
• rsd_nginx_dhparam_file_path
  • По умолчанию: "/etc/ssl/private/dhparam.pem"
  • Описание: Абсолютный путь назначения для файла параметров DH.
• rsd_swagger_enabled
  • По умолчанию: false
  • Описание: Включен ли Swagger или нет.
• rsd_swagger_version
  • По умолчанию: v4.15.0
  • Описание: Версия образа Docker swaggerapi/swagger-ui.
• rsd_prune_volumes
  • По умолчанию: false
  • Описание: Установите в true, чтобы удалить данные Docker volumes (это приведет к пересозданию контейнеров).
• rsd_migrate_spotlights
  • По умолчанию: false
  • Описание: Установите в true, чтобы перенести программные "споты" с hifis.net в RSD (тема Helmholtz только).
• rsd_spotlight_migration_image
  • По умолчанию: "ghcr.io/hifis-net/rsd-spotlight-migration:v1.0.0"
  • Описание: Образ контейнера для миграции программных "спотов".

Переменные окружения RSD

• rsd_compose_project_name
  • По умолчанию: "rsd"
  • Описание: Определите имя проекта Compose, если вы запускаете разные версии RSD.
• rsd_domain
  • По умолчанию: "localhost"
  • Описание: Имя домена, под которым RSD должен быть доступен.
• rsd_auth_providers
  • По умолчанию: "SURFCONEXT;HELMHOLTZAAI"
  • Описание: Список поддерживаемых провайдеров OpenID, разделенных точкой с запятой.
• rsd_admin_email_list
  • По умолчанию: None
  • Описание: Список адресов электронной почты пользователей (точное совпадение, включая регистр) администраторов RSD, разделенных точкой с запятой.
• rsd_auth_user_mail_whitelist
  • По умолчанию: None
  • Описание: Список адресов электронной почты пользователей, которым разрешено входить в RSD, разделенных точкой с запятой.
• rsd_hgfaai_client_id
  • По умолчанию: "rsd-dev"
  • Описание: Публичный клиентский идентификатор Helmholtz AAI.
• rsd_hgfaai_client_secret
  • По умолчанию: "changeme"
  • Описание: Секрет клиента Helmholtz AAI.
• rsd_hgfaai_well_known_url
  • По умолчанию: "https://login-dev.helmholtz.de/oauth2/.well-known/openid-configuration"
  • Описание: Известный URL Helmholtz AAI.
• rsd_hgfaai_allow_external_users
  • По умолчанию: false
  • Описание: Установите в true, чтобы разрешить пользователям из центров, не относящимся к Helmholtz, или социальных идентификационных провайдеров.
• rsd_postgres_db_host
  • По умолчанию: "database"
  • Описание: Имя хоста базы данных Postgres.
• rsd_postgres_db_host_port
  • По умолчанию: "5432"
  • Описание: Порт хоста базы данных Postgres.
• rsd_postgres_db
  • По умолчанию: "rsd-db"
  • Описание: Имя базы данных Postgres.
• rsd_postgres_user
  • По умолчанию: "rsd"
  • Описание: Имя пользователя Postgres.
• rsd_postgres_password
  • По умолчанию: "changeme"
  • Описание: Пароль Postgres.
• rsd_postgres_authenticator_password
  • По умолчанию: "ChangeMe"
  • Описание: Пароль аутентификатора Postgres, используемый бэкендом (должен отличаться от rsd_postgres_password).
• rsd_max_requests_github
  • По умолчанию: "6"
  • Описание: Максимальное количество запросов к API GitHub за один запуск.
• rsd_max_requests_gitlab
  • По умолчанию: "6"
  • Описание: Максимальное количество запросов к API GitLab за один запуск.
• rsd_max_requests_doi
  • По умолчанию: "6"
  • Описание: Максимальное количество упоминаний для извлечения за один запуск.
• rsd_oaipmh_scraper_enabled
  • По умолчанию: false
  • Описание: Установите в true, чтобы включить скребок oaipmh.
• rsd_surfconext_client_secret
  • По умолчанию: "changeme"
  • Описание: Секрет клиента SurfConext.
• rsd_gh_access_token
  • По умолчанию: "changeme"
  • Описание: Личный токен доступа GitHub.
• rsd_jwt_secret
  • По умолчанию: "changemeChangemeChangemeChangeme"
  • Описание: Секрет токена JSON Web с как минимум 32 символами для генерации/подтверждения токенов.
• rsd_zenodo_access_token
  • По умолчанию: "changeme"
  • Описание: Токен доступа Zenodo.
• rsd_crossref_contact_email
  • По умолчанию: ""
  • Описание: Адрес электронной почты, по которому Crossref может с вами связаться для соблюдения их "вежливой" политики.
• rsd_matomo_url
  • По умолчанию: ""
  • Описание: URL отслеживания (должен заканчиваться слешем).
• rsd_matomo_id
  • По умолчанию: ""
  • Описание: ID Matomo для соответствующего URL отслеживания.

Зависимости

Директорий Исследовательского Программного Обеспечения требует наличия docker и docker-compose в системе. Эта роль успешно использовалась вместе с следующими ролями Ansible:

• Docker - geerlingguy.docker
• Pip - geerlingguy.pip

Пример Плейбука

- hosts: servers
  roles:
     - { role: hifis.rsd }

Лицензия

Apache-2.0

Информация об авторе

Эта роль была создана HIFIS Software Services.

Участники

Мы хотели бы поблагодарить и отдать должное следующим участникам этого проекта:

• tharun634