Rôle Ansible : Répertoire de Logiciels de Recherche (RSD-en-service)

Configuration du Répertoire de Logiciels de Recherche utilisant Ansible.

Les plates-formes supportées actuellement sont :

• Ubuntu 20.04 LTS
• Ubuntu 22.04 LTS

Exigences

• docker (SDK Docker pour Python)
• docker-compose

Variables de Rôle

• rsd_dependencies
  • Par défaut : ["docker", "docker-compose"]
  • Description : Liste des modules Python nécessaires.
• rsd_working_directory
  • Par défaut : "/opt/rsd"
  • Description : Le chemin où le dépôt RSD sera téléchargé.
• rsd_version
  • Par défaut : "latest"
  • Description : Quelle version des images de conteneur RSD-en-service déployer (nom de la balise de l'image). Si latest est utilisé, les images de conteneur seront toujours téléchargées avant de démarrer l'application.
• rsd_container_registry_path
  • Par défaut : "ghcr.io/hifis-net/rsd-saas"
  • Description : Chemin vers le registre de conteneurs d'où les images sont téléchargées.
• rsd_environment_file
  • Par défaut : "rsd-secrets.env"
  • Description : Fichier d'environnement spécifique à l'inventaire.
• rsd_docker_compose_cmd
  • Par défaut : "docker-compose"
  • Description : Commande Docker Compose utilisée pour valider docker-compose.yml.
• rsd_docker_compose_template_file
  • Par défaut : "docker-compose.yml.j2"
  • Description : Fichier modèle pour docker-compose.yml.
• rsd_nginx_config_template
  • Par défaut : "nginx.conf.j2"
  • Description : Fichier modèle pour la configuration Nginx.
• rsd_tls_cert_path
  • Par défaut : "/etc/ssl/certs/rsd.pem"
  • Description : Chemin absolu pour le fichier de certificat TLS.
• rsd_tls_key_path
  • Par défaut : "/etc/ssl/private/rsd.key"
  • Description : Chemin absolu pour le fichier de clé TLS.
• rsd_nginx_dhparam_file_path
  • Par défaut : "/etc/ssl/private/dhparam.pem"
  • Description : Chemin absolu pour le fichier de paramètres DH.
• rsd_swagger_enabled
  • Par défaut : false
  • Description : Indique si Swagger est activé ou non.
• rsd_swagger_version
  • Par défaut : v4.15.0
  • Description : Version de l'image Docker swaggerapi/swagger-ui.
• rsd_prune_volumes
  • Par défaut : false
  • Description : Mettre sur true pour supprimer les volumes de données Docker (cela forcera la recréation des conteneurs).
• rsd_migrate_spotlights
  • Par défaut : false
  • Description : Mettre sur true pour migrer les mises en avant des logiciels de hifis.net vers le RSD (uniquement le thème Helmholtz).
• rsd_spotlight_migration_image
  • Par défaut : "ghcr.io/hifis-net/rsd-spotlight-migration:v1.0.0"
  • Description : Image de conteneur pour la migration des mises en avant des logiciels.

Variables d'environnement RSD

• rsd_compose_project_name
  • Par défaut : "rsd"
  • Description : Définit le nom du projet Compose, si vous exécutez différentes versions du RSD.
• rsd_domain
  • Par défaut : "localhost"
  • Description : Nom de domaine sous lequel le RSD doit être accessible.
• rsd_auth_providers
  • Par défaut : "SURFCONEXT;HELMHOLTZAAI"
  • Description : Liste séparée par des points-virgules des fournisseurs d'authentification OpenID supportés.
• rsd_admin_email_list
  • Par défaut : None
  • Description : Liste séparée par des points-virgules des adresses e-mail des utilisateurs (correspondance exacte y compris la casse des lettres) des administrateurs RSD.
• rsd_auth_user_mail_whitelist
  • Par défaut : None
  • Description : Liste séparée par des points-virgules des adresses e-mail des utilisateurs autorisés à se connecter au RSD.
• rsd_hgfaai_client_id
  • Par défaut : "rsd-dev"
  • Description : ID client public Helmholtz AAI.
• rsd_hgfaai_client_secret
  • Par défaut : "changeme"
  • Description : Secret du client Helmholtz AAI.
• rsd_hgfaai_well_known_url
  • Par défaut : "https://login-dev.helmholtz.de/oauth2/.well-known/openid-configuration"
  • Description : URL bien connue de Helmholtz AAI.
• rsd_hgfaai_allow_external_users
  • Par défaut : false
  • Description : Mettre sur true pour autoriser les utilisateurs de centres non-HfI ou d'IdPs sociaux.
• rsd_postgres_db_host
  • Par défaut : "database"
  • Description : Nom d'hôte de la base de données Postgres.
• rsd_postgres_db_host_port
  • Par défaut : "5432"
  • Description : Port d'hôte pour la base de données Postgres.
• rsd_postgres_db
  • Par défaut : "rsd-db"
  • Description : Nom de la base de données Postgres.
• rsd_postgres_user
  • Par défaut : "rsd"
  • Description : Nom d'utilisateur Postgres.
• rsd_postgres_password
  • Par défaut : "changeme"
  • Description : Mot de passe Postgres.
• rsd_postgres_authenticator_password
  • Par défaut : "ChangeMe"
  • Description : Mot de passe d'authentification Postgres utilisé par le backend (devrait être différent de rsd_postgres_password).
• rsd_max_requests_github
  • Par défaut : "6"
  • Description : Nombre maximum de requêtes à l'API GitHub par exécution.
• rsd_max_requests_gitlab
  • Par défaut : "6"
  • Description : Nombre maximum de requêtes à l'API GitLab par exécution.
• rsd_max_requests_doi
  • Par défaut : "6"
  • Description : Nombre maximum de mentions à récupérer par exécution.
• rsd_oaipmh_scraper_enabled
  • Par défaut : false
  • Description : Mettre sur true pour activer le scrapper oaipmh.
• rsd_surfconext_client_secret
  • Par défaut : "changeme"
  • Description : Secret du client SurfConext.
• rsd_gh_access_token
  • Par défaut : "changeme"
  • Description : Jeton d'accès personnel GitHub.
• rsd_jwt_secret
  • Par défaut : "changemeChangemeChangemeChangeme"
  • Description : Secret du jeton web JSON avec au moins 32 caractères pour générer/vérifier les jetons.
• rsd_zenodo_access_token
  • Par défaut : "changeme"
  • Description : Jeton d'accès Zenodo.
• rsd_crossref_contact_email
  • Par défaut : ""
  • Description : Adresse e-mail par laquelle Crossref peut vous contacter pour respecter leur politique "polie".
• rsd_matomo_url
  • Par défaut : ""
  • Description : URL de suivi (doit se terminer par un slash final).
• rsd_matomo_id
  • Par défaut : ""
  • Description : ID Matomo pour l'URL de suivi correspondante.

Dépendances

Le Répertoire de Logiciels de Recherche nécessite que docker et docker-compose soient disponibles sur le système. Ce rôle a été utilisé avec succès avec les rôles Ansible suivants :

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

Exemple de Playbook

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

Licence

Apache-2.0

Informations sur l'Auteur

Ce rôle a été créé par HIFIS Software Services.

Contributeurs

Nous tenons à remercier et à donner des crédits aux contributeurs suivants de ce projet :

• tharun634