1. 概要 一覧へ 3. netbox-certcheckerの使い方
本章では、netbox-certcheckerのインストール方法について解説します。
この手順を行うためには、netbox(v3.7.0以上)がインストールされている必要があります。 netboxのインストール・設定については、次のサイトをご覧ください。
netbox-certcheckerをGithubからダウンロードします。 GithubのリポジトリURLは次の通りです。 リリースにある最新版のtar.gzを利用してください。
netboxのインストールされた環境に、 netbox_certchecker.tar.gz を 転送し、次のコマンドを実行してください。
$ pip install netbox_certchecker.tar.gz
Note
Pythonのvenv環境を利用してnetboxをインストールしている場合、venvを有効にしてから実行してください。
netboxの設定ファイルに、次の内容を追加します。 以下は /opt/netbox にnetboxがインストールされている場合の例です。
PLUGINS = ['netbox_certchecker']
次に、プラグインが利用するDBの初期化を行います。 次のコマンドを実行してください。
$ /opt/netbox/netbox/manage.py migrate
最後にnetboxサービスを再起動します。 次はnetboxをsystemdで管理している場合の例です。
# systemctl restart netbox
# systemctl restart netbox-rq
証明書検査スクリプトは、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への接続情報や、メールの通知情報の 設定ファイルを作成します。
# メールに記載される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
設定後、netboxにログインするとプラグインのメニューが追加されます。 次のような画面が表示されれば、設定は成功しています。
