役割 geoip

• Ansible Galaxy ページ <https://galaxy.ansible.com/honzamach/geoip>__
• GitHub リポジトリ <https://github.com/honzamach/ansible-role-geoip>__
• Travis CI ページ <https://travis-ci.org/honzamach/ansible-role-geoip>__

このAnsibleロールは、MaxMind <https://www.maxmind.com/en/home>__によって提供される無料のIPジオロケーションデータベース GeoLite2 <https://dev.maxmind.com/geoip/geoip2/geolite2/#Download_Access>__を簡単にインストールするためのものです。

目次:

• :ref:section-role-geoip-installation
• :ref:section-role-geoip-dependencies
• :ref:section-role-geoip-usage
• :ref:section-role-geoip-variables
• :ref:section-role-geoip-files
• :ref:section-role-geoip-author

このロールは、MSMS <https://github.com/honzamach/msms>__パッケージの一部です。 いくつかの一般的な機能は、その :ref:manual <section-manual> に記載されています。

.. _section-role-geoip-installation:

インストール

Ansible Galaxy <https://galaxy.ansible.com/>__ からロール honzamach.geoip <https://galaxy.ansible.com/honzamach/geoip>__ をインストールするには、以下のコマンドを実行してください::

ansible-galaxy install honzamach.geoip

GitHub <https://github.com>__ から ansible-role-geoip <https://github.com/honzamach/ansible-role-geoip>__ リポジトリをクローンして直接インストールするには、以下のコマンドを実行してください::

git clone https://github.com/honzamach/ansible-role-geoip.git honzamach.geoip

直接Gitクローンを使う利点は、新しいバージョンが出た際に簡単にロールを更新できることです。

.. _section-role-geoip-dependencies:

依存関係

このロールは他のロールに依存していません。

このロールに依存しているロールは以下の通りです:

• :ref:mentat <section-role-mentat>
• :ref:mentat_dev <section-role-mentat-dev>

.. _section-role-geoip-usage:

使用方法

inventory ファイルの例::

[servers_geoip]
your-server

role_playbook.yml ファイルの例::

- hosts: servers_geoip
  remote_user: root
  roles:
    - role: honzamach.geoip
  tags:
    - role-geoip

使用例::

# 全てを実行:
ansible-playbook --ask-vault-pass --inventory inventory role_playbook.yml

以下の設定原則に従うことをお勧めします:

• inventory/group_vars/all/vars.yml ファイルを作成/編集し、管理するサーバー全体のための合理的な デフォルトを設定します。例::

    hm_geoip__account_id: "{{ vault_hm_geoip__account_id }}"
    hm_geoip__license_key: "{{ vault_hm_geoip__license_key }}"
  

• :ref:vault <section-overview-vault> 暗号化ファイル inventory/group_vars/all/vault.yml を作成/編集し、 バックアップ暗号パスワードを保存します::

    vault_hm_geoip__account_id: 123456
    vault_hm_geoip__license_key: something-so-secret-no1-is-gonna-guess
  

• inventory/host_vars/[your-server]/vars.yml ファイルを使用して、特定のサーバーに対する設定をカスタマイズします。 使用可能なオプションについては :ref:section-role-geoip-variables を参照してください。

.. _section-role-geoip-variables:

設定変数

内部ロール変数

.. envvar:: hm_geoip__package_url

    geoipupdateユーティリティをインストールするためのパッケージのデフォルトURL。

    * *データ型:* ``string``
    * *デフォルト:* ``https://github.com/maxmind/geoipupdate/releases/download/v4.1.5/geoipupdate_4.1.5_linux_amd64.deb``

.. envvar:: hm_geoip__account_id

    あなたのMaxMindアカウントのユニークな識別子（数値）。

    * *データ型:* ``integer``
    * *デフォルト:* ``null``

.. envvar:: hm_geoip__license_key

    あなたのMaxMindアカウントのライセンスキー。キーを作成する際に *Update* オプションが有効になっていることを確認してください。

    * *データ型:* ``string``
    * *デフォルト:* ``null``

.. envvar:: hm_geoip__edition_ids

    対象ホストにインストールするための要求されたIPジオロケーションデータベースのリスト。

    * *データ型:* ``list of strings``
    * *デフォルト:* ``["GeoLite2-ASN", "GeoLite2-City", "GeoLite2-Country"]``

.. envvar:: hm_geoip__database_directory

    データベースファイルを保存するディレクトリ。

    * *データ型:* ``string``
    * *デフォルト:* ``/usr/share/GeoIP``


組み込まれたAnsible変数

.. envvar:: ansible_lsb['codename']

Debianディストリビューションのコードネームは :ref:`template customization <section-overview-role-customize-templates>` 機能に使用されます。

.. _section-role-geoip-files:

管理ファイル

.. note::

このロールは :ref:`template customization <section-overview-role-customize-templates>` 機能をサポートしています。

このロールは、対象システムで以下のファイルの内容を管理します:

• /etc/cron.d/geoipupdate [テンプレート]
• /etc/GeoIP.conf [テンプレート]

.. _section-role-geoip-author:

著者とライセンス

| 著作権: 2019年以降 (C) Honza Mach honza.mach.ml@gmail.com | 著者: Honza Mach honza.mach.ml@gmail.com | このロールの使用はMITライセンスによって規定されており、LICENSEファイルを参照してください。