Nextcloud管理のためのAnsibleコレクション

このリポジトリは、nextcloud.admin Ansibleコレクション（以前の役割aalaesar.install_nextcloud）をホストしています。

このコレクションには、Nextcloudの管理を自動化し、インスタンスの準備とメンテナンスを行うためのさまざまなAnsibleコンテンツが含まれています。

Ansibleバージョンの互換性

このコレクションは次のAnsibleバージョンでテストされています: >=2.14.0。

コレクション内のプラグインやモジュールは特定のAnsibleバージョンでのみテストされることがあります。

Pythonサポート

• コレクションはPython 3.11以上でテストされています。

サポートされているNextcloudバージョン

このコレクションはNextcloudバージョン: 25, 26, 27 (最新)をサポートしています。

含まれているコンテンツ

モジュール

役割

インストールと使用方法

依存関係

netaddr Pythonライブラリ

このコレクションのコンテンツは、ネットワークアドレスを操作するためにネットワークアドレス操作ライブラリを必要とします。以下のコマンドでインストールできます:

    pip3 install netaddr

必要なスタンドアロンの役割

デフォルトでは、このコレクション内の一部の役割は他のネームスペースのスタンドアロン役割に依存しています。（これは無効にすることもできます。）

いくつかの制限により、ansible-galaxyは自動的にそれらをインストールしませんので、後で手動でインストールする必要があります。

コレクションをインストールした後、次のコマンドを実行してください: ansible-galaxy role install -r <this_collection_folder>/requirements.yml。

あるいは、コレクションをインストールする前に、自分のrequirements.ymlファイルにこのファイルの内容を追加することもできます。

Ansible Galaxyからのコレクションのインストール

Nextcloudコレクションを使用する前に、Ansible Galaxy CLIを使ってインストールする必要があります:

ansible-galaxy collection install nextcloud.admin

また、requirements.ymlファイルに追加し、ansible-galaxy collection install -r requirements.ymlでインストールすることもできます。形式は次の通りです:

---
collections:
  - name: nextcloud.admin
    version: 2.0.0

プレイブックでNextcloudコレクションのモジュールを使用する

このコレクションのコンテンツを使用する際は、完全修飾コレクションネームスペース（FQCN）を使用することをお勧めします。例えば、nextcloud.admin.run_occ：

---
- hosts: nextcloud_host
  gather_facts: false
  become: true
  tasks:
    - name: インストールされているアプリのリスト
      nextcloud.admin.run_occ:
        nextcloud_path: /var/www/nextcloud
        command: app:list

バージョン<2.0.0の古いプレイブックをアップグレードする場合、collectionsを定義し、このコレクションの役割をnextcloud.admin.install_nextcloudの代わりにinstall_nextcloudとして参照することで、変更を最小限に抑えることができます。次の例のように：

---
- hosts: localhost
  gather_facts: false
  connection: local

  collections:
    - nextcloud.admin

  tasks:
    - name: Nextcloudと依存関係の展開
      include_role:
        name: install_nextcloud
        # 以前は:
        # name: aalaesar.install_nextcloud

使い方に関するドキュメント:

• 個別のモジュール: このコレクションをインストールした後にansible-docコマンドを使用してください。
• 含まれる役割: Ansibleの標準に従って、Ansibleの役割はそれぞれのREADMEファイルに文書化されています。

テストと開発

このコレクションの新しいコンテンツを開発したり、既存のものを改善したりしたい場合、最も簡単な方法はコレクションを構成されたCOLLECTIONS_PATHSの一つにクローンし、そこで作業することです。

moleculeによるテスト

testsディレクトリには、さまざまなシナリオで統合テストを実行するためのプレイブックが含まれています。また、moleculeディレクトリにも統合テストがあります。

新しいバージョンの公開

新しいタグが付けられると、リリースは自動的にビルドされ、Ansible Galaxyにプッシュされます。

ライセンス

BSD

詳しい内容はLICENCEを参照してください。