メインコンテンツまでスキップ

インストールポイント管理

インストールポイントは、clmBot 設定ファイル内の証明書デプロイ先であり、証明書形式(format)、ファイルパス、更新スクリプトで構成されます。1 つの clmBot ノードで複数のインストールポイントを管理できます。

clmBot は以下のインストールポイント管理コマンドを提供します。

コマンド用途
discover-certificateサーバー本体(および Docker コンテナ内)の証明書を自動スキャンし、インストールポイントとして追加します
add-server対話形式でインストールポイントを手動追加します(ローカル設定のみに書き込み)
sync-serverローカルのインストールポイントをクラウドへ同期し、証明書サブスクリプション番号を調整します
setupローカル Web 設定ページを起動し、ブラウザ上でインストールポイントを管理します
query-certificate各インストールポイントに現在デプロイされている証明書情報を読み取り専用で表示します

証明書インストールポイントの自動検出​

discover-certificate を実行すると、サーバー上にデプロイ済みの証明書を自動スキャンします。

./clm-bot-linux-amd64 discover-certificate

スキャン範囲:

  • Linux:nginx、Apache HTTP Server、Tomcat。
  • Windows:IIS。

コマンド実行後、検出された証明書情報(ソース、種類、認証局(CA)、サブジェクト、パス、アクセスポイント、シリアル番号など)が表形式で一覧表示されます。アップロードする証明書の番号を入力して、管理バックエンドへの追加を確定します:

  • all:すべてアップロード
  • none:アップロードしない
  • 1,3-5:番号で選択、範囲指定に対応

アップロードが成功すると、これらの証明書はインストールポイントとして管理バックエンドに表示され、clmBot は config.yaml 内で各インストールポイントに対応する設定を生成します。

使用可能なパラメータ​

パラメータ説明
--yes / -y選択をスキップし、すべてのインストールポイントをアップロード
--selectアップロードする番号を直接指定します(all、none または 1,3-5)。--yes とは排他です
--skip-filter / -s証明書ドメイン(SAN)フィルタリングをスキップします。デフォルトではクラウド側で許可されたドメインに一致する証明書のみアップロードされます
--scan-docker / -dDocker コンテナ内の nginx、Apache、Tomcat 設定を追加でスキャン(Linux/macOS のみ)
--scan-onlyすべての証明書インストールポイントのみをスキャンして出力。ログインやアップロードは行わないため、デプロイ前のプレビューに適しています

Docker コンテナのシナリオ​

--scan-docker を使用すると、clmBot はホスト上で稼働中の nginx、Apache、Tomcat コンテナをスキャンします。

  • コンテナ内の証明書パスはホストにマウントされ、書き込み可能である必要があります。そうでない場合、そのインストールポイントは無視されます。
  • インストールポイントのアクセスポイントは、ホストが公開する IP とポートを使用して生成されます。
  • CLMBOT_NGINX_CONTAINERS、CLMBOT_APACHE_CONTAINERS、CLMBOT_TOMCAT_CONTAINERS 環境変数を使用して、スキャン対象のコンテナ名を指定できます(複数のコンテナ名はセミコロンで区切ります)。

インストールポイントの手動追加​

クラウド証明書がサーバーにデプロイされていない場合、または自動スキャンで認識されなかった場合は、インストールポイントを手動で追加できます。

./clm-bot-linux-amd64 add-server 260101AABBCC pem

最初のパラメータは証明書サブスクリプション番号、2番目のパラメータは証明書フォーマット(pem、pfx、jks、iis または exchange)です。プロンプトに従ってインストールポイントIDと対応するフォーマットのファイルパスなどの情報を順番に入力します。

add-server はインストールポイントをローカルの config.yaml に書き込むだけで、自動的にクラウドへアップロードしません。クラウドへ同期する必要がある場合は、続けて sync-server を実行してください。

インストールポイントをクラウドへ同期​

sync-server ローカル構成のインストールポイントをクラウドにアップロードし、クラウドから返されたサブスクリプション番号を使用してローカル構成を補完または調整します。

./clm-bot-linux-amd64 sync-server

実行後、ローカルインストールポイントが一覧表示されます。番号でアップロードする項目を選択します(all、none、1,3-5 も同様に対応しています)。また、--yes を使用してすべてアップロードするか、--select で直接指定することもできます。

情報
  • ローカルサブスクリプション番号が空の場合は自動的に補完されます。クラウドと一致しない場合は競合が一覧表示され、確認後にのみ上書きされます。
  • Exchange 形式のインストールポイントは同期に対応していません。

ローカル Web 設定ページ​

コマンドラインに慣れていない場合は、setup を使用してローカル設定ページを起動し、ブラウザでインストールポイントの追加、編集、削除を行うことができます。

./clm-bot-linux-amd64 setup

実行後、ランダムなトークンを含むアクセスURL(http://localhost:<端口>/setup?token=... の形式)が出力されます。サーバー上のブラウザーでこのURLを開くと、インストール先を管理できます。

注意

設定ページはサーバー自身のループバックアドレスでのみ待ち受け、他のホストからはアクセスできません。トークンを含むアクセスURLを無関係な人に漏らさないでください。使用後は Ctrl+C を押すか、表示される案内に従ってページを停止してください。

ポートを指定する場合は -a パラメーター(例:setup -a localhost:8900)を使用します。古いブラウザー環境では --legacy を追加すると、プレーンHTMLの設定ページを利用できます。

インストール先の証明書情報を確認する​

query-certificate は、各インストール先に現在配備されている証明書情報(サブジェクト、発行者、シリアル番号)を読み取り専用で確認し、証明書ファイルは変更しません:

./clm-bot-linux-amd64 query-certificate

デフォルトではすべてのインストールポイントを照会します。-i パラメータでインストールポイント ID を指定できます。例:query-certificate -i nginx_pem。

次のステップ​

インストールポイントの準備が完了したら、証明書の更新方法を設定してください。詳しくは証明書の更新方法をご参照ください。