hifis.rsd

概要バージョン洞察

<!--
著作権表記: 2022 ヘルムホルツ環境研究センター (UFZ)
著作権表記: 2022 ヘルムホルツ・ツェントルム・ドレスデン・ロッセンドルフ (HZDR)
著作権表記: 2022 ヘルムホルツ研究所ポツダム - GFZドイツ地球科学研究センター

ライセンス: Apache-2.0
-->

# Ansibleロール: 研究ソフトウェアディレクトリ (RSD-as-a-service)

[![CIステータス](https://github.com/hifis-net/ansible-role-rsd/actions/workflows/ci.yml/badge.svg)](https://github.com/hifis-net/ansible-role-rsd/actions/workflows/ci.yml)
[![Ansibleロール: hifis.unattended_upgrades](https://img.shields.io/ansible/role/58679)](https://galaxy.ansible.com/hifis/rsd)
[![Ansible品質スコア](https://img.shields.io/ansible/quality/58679)](https://galaxy.ansible.com/hifis/rsd)
[![Ansibleロールダウンロード数](https://img.shields.io/ansible/role/d/58679)](https://galaxy.ansible.com/hifis/rsd)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7008976.svg)](https://doi.org/10.5281/zenodo.7008976)

Ansibleを使用した[研究ソフトウェアディレクトリ](https://github.com/research-software-directory/RSD-as-a-service)の設定。

現在サポートされているプラットフォームは次のとおりです:
* Ubuntu 20.04 LTS
* Ubuntu 22.04 LTS

## 要件

* [`docker`](https://pypi.org/project/docker/) (Python用Docker SDK)
* [`docker-compose`](https://pypi.org/project/docker-compose/)

## ロール変数

- `rsd_dependencies`
  - デフォルト: `["docker", "docker-compose"]`
  - 説明: 必要なPythonモジュールのリスト。
- `rsd_working_directory`
  - デフォルト: `"/opt/rsd"`
  - 説明: RSDリポジトリがチェックアウトされるパス。
- `rsd_version`
  - デフォルト: `"latest"`
  - 説明: デプロイするRSD-as-a-serviceのコンテナイメージのバージョン（イメージタグ名）。
- `rsd_container_registry_path`
  - デフォルト: `"ghcr.io/hifis-net/rsd-saas"`
  - 説明: イメージを取得するコンテナレジストリのパス。
- `rsd_environment_file`
  - デフォルト: `"rsd-secrets.env"`
  - 説明: 環境設定用の特定インベントリファイル。
- `rsd_docker_compose_cmd`
  - デフォルト: `"docker-compose"`
  - 説明: docker-compose.ymlを検証する際に使用されるDocker Composeコマンド。
- `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環境変数
- `rsd_domain`
  - デフォルト: `"localhost"`
  - 説明: RSDにアクセスするためのドメイン名。
- `rsd_auth_providers`
  - デフォルト: `"SURFCONEXT;HELMHOLTZAAI"`
  - 説明: サポートされているOpenID認証プロバイダのセミコロン区切りリスト。

## 依存関係

研究ソフトウェアディレクトリは、システムに`docker`と`docker-compose`が必要です。このロールは以下のAnsibleロールと合わせて正常に使用されました:
* Docker - [geerlingguy.docker](https://galaxy.ansible.com/geerlingguy/docker)
* Pip - [geerlingguy.pip](https://galaxy.ansible.com/geerlingguy/pip)

## サンプルプレイブック

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