オープンソース

一覧へ

2. インストール

本章では、netbox-certcheckerのインストール方法について解説します。

2.1. 前提

この手順を行うためには、Netbox(v3.7.0以上)がインストールされている必要があります。 Netboxのインストール・設定については、次のサイトをご覧ください。

2.2. netbox-certcheckerの入手

netbox-certcheckerをGithubからダウンロードします。 GithubのリポジトリURLは次の通りです。 リリースにある最新版のtar.gzを利用してください。

2.3. インストール

Netboxのインストールされた環境に、 netbox_certchecker.tar.gz を 転送し、次のコマンドを実行してください。

$ pip install netbox_certchecker.tar.gz

Note

Pythonのvenv環境を利用してNetboxをインストールしている場合、venvを有効にしてから実行してください。

2.4. netbox-certcheckerの有効化

Netboxの設定ファイルに、次の内容を追加します。 以下は /opt/netbox にNetboxがインストールされている場合の例です。

  • /opt/netbox/netbox/netbox/configuration.py
PLUGINS = ['netbox_certchecker']

次に、プラグインが利用するDBの初期化を行います。 次のコマンドを実行してください。

$ /opt/netbox/netbox/manage.py migrate

最後にNetboxサービスを再起動します。 次はNetboxをsystemdで管理している場合の例です。

# systemctl restart netbox
# systemctl restart netbox-rq

2.5. 証明書検査スクリプトの設定

証明書検査スクリプトは、Netboxに登録されたURLのSSL証明書の情報を検査し、 SSLエラーの発生や、有効期限まで30日以内になった場合に、アラートメールを 送信するようになっています。

アラート通知スクリプトは、ダウンロードしたtar.gzに含まれています。 tar.gzを展開してスクリプトを配置します。

# tar zxf netbox_certchecker.tar.gz
# cp netbox_certchecker/tools/certchecker.sh /usr/local/bin/
# chmod a+x /usr/local/bin/certchecker.sh

次にスクリプトが利用するNetboxへの接続情報や、メールの通知情報の 設定ファイルを作成します。

  • /etc/netbox_certchecker.conf
# メールに記載されるNetboxのURLのプレフィックス
NETBOX_URLPREF="https://netbox.example.com/plugins/certchecker/certchecker"

# プラグインAPIのエンドポイント
API_ENDPOINT="https://netbox.example.com/api/plugins/certchecker/certchecker/?alert=true"

# 管理者またはプラグインが参照できるユーザが発行した認証トークン
API_TOKEN="your_admin_token"

# メールのFrom
MAIL_FROM="sender@example.com"

# メールの宛先
MAIL_RECIPIENT="rcpt@example.com"

# SMTPサーバの情報
SMTP_SERVER="localhost"
SMTP_PORT="25"
SMTP_USER="user"
SMTP_PASSWORD="password"

# メールの件名
SUBJECT_PREF="[Netbox] Certificate error detected for"

# 証明書期限切れ警告の閾値となる日数
EXPIRE_WARN_DAY=30

最後にcrontabで定期処理の設定を行います。 次は毎日0時にスクリプトを実行する例です。

# crontab -e
* 0 * * *  /usr/local/bin/certchecker.sh

2.6. 設定後の確認

設定後、Netboxにログインするとプラグインのメニューが追加されます。 次のような画面が表示されれば、設定は成功しています。

_images/top.png
一覧へ